[]
デモ ヘルプ APIリファレンス
トライアル版
(Showing Draft Content)

Inputman.GcComment

GcComment クラス

GcComment

階層

  • GcComment

コンストラクタ

プロパティ

メソッド

イベント

コンストラクタ

constructor

  • var gcComment = new GC.InputMan.GcComment(document.getElementById("comment"), {
    commentMode: GC.InputMan.GcCommentMode.ChatMode,
    userInfo: {
         id: '1',
         name: 'user',
         avatar: './image/avatar.png'
    },
    editorConfig: {
         editorType: GC.InputMan.GcCommentEditorType.GcRichTextEditor,
    },
});

    引数

    • el: HTMLElement

      元のHTML要素。GcCommentはこの要素を非表示にし、下に新しい要素を生成します。

    • オプション config: GcCommentConfig

      Configオブジェクト。GcCommentの表示モード、ユーザー情報、コメントエディタの設定をカスタマイズします。参照 GcCommentConfig

    戻り値 GcComment

プロパティ

comments

comments: IComment[]

コメントを取得または設定します。

userInfo

userInfo: UserInfo

ユーザー情報を取得または設定します。

メソッド

addCommand

  • GcCommentにカスタムコマンドを追加します

    Type parameters

    引数

    • name: T | string

      カスタムコマンド名。参照 ExecuteCommandOption

    • command: CommandAction<ExecuteCommandOption[T]> | CommandAction<any>

      コマンドが実行されたときに発生します。参照 CommandAction

      gcComment.addCommand('SortByUpdateTime', ()=>{
      gcComment.sort({isDesc: true, sortBy: GC.InputMan.GcCommentSortBy.UpdateTime});
});

    戻り値 void

addComment

  • コメントを追加します

    引数

    • comment: IComment

      GcCommentに追加されるコメントオブジェクト。参照 IComment

      gcComment.addComment(comment);

    戻り値 void

addEventListener

  • addEventListener<K>(evt: K | string, handler: GcCommentEventHandlerMap[K]): void

  • イベントにメソッドを追加します

    Type parameters

    引数

    • evt: K | string

      イベント名。参照 GcCommentEventHandlerMap

    • handler: GcCommentEventHandlerMap[K]

      ハンドラー。参照 GcCommentEventHandlerMap

      var onEditorCreated = () => {
     console.log('editor created');
};
gcComment.addEventListener(GC.InputMan.GcCommentEvent.EditorCreated, onEditorCreated);

    戻り値 void

clear

  • clear(): void

  • 読み込んだコメントをクリアします

    gcComment.clear();

    戻り値 void

execCommand

  • execCommand<T>(name: T | string, commandOptions?: ExecuteCommandOption[T] | any): void

  • コマンドを実行します

    Type parameters

    引数

    • name: T | string

      コマンド名。参照 ExecuteCommandOption

    • オプション commandOptions: ExecuteCommandOption[T] | any

      コマンドパラメータの情報。参照 ExecuteCommandOption

      gcComment.execCommand('SortByUpdateTime');

    戻り値 void

getCommentElement

  • getCommentElement(id: string): HTMLElement | null

  • コメントIDによってHTMLElementを取得します

    引数

    • id: string

    戻り値 HTMLElement | null

getElement

  • getElement(): HTMLElement

  • 元の要素を取得します

    戻り値 HTMLElement

    元の要素

    let element = gcComment.getElement();

reactToComment

  • reactToComment(commentId: string, reactChar: string): void

  • 特定のコメントにリアクションを追加します。既に現在のユーザーによって追加されたリアクションがある場合はそのリアクションを解除します。

    引数

    • commentId: string

      リアクションが追加されるコメントのID

    • reactChar: string

      追加されるリアクションキャラクター

      gcComment.replyToComment('id_1', '👍');

    戻り値 void

reload

  • reload(): void

  • コメントを再読込みします

    gcComment.reload();

    戻り値 void

removeComment

  • removeComment(commentId: string): void

  • 指定したコメントを削除します

    引数

    • commentId: string

      削除されるコメントID

      gcComment.removeComment('id_1');

    戻り値 void

removeEventListener

  • removeEventListener<K>(evt: K | string, handler: GcCommentEventHandlerMap[K]): void

  • イベントにメソッドを削除します

    Type parameters

    引数

    • evt: K | string

      イベント名。参照 GcCommentEventHandlerMap

    • handler: GcCommentEventHandlerMap[K]

      ハンドラー。参照 GcCommentEventHandlerMap

      gcComment.removeEventListener(GC.InputMan.GcCommentEvent.EditorCreated, onEditorCreated);

    戻り値 void

replyToComment

  • replyToComment(commentId: string, reply: IComment): void

  • 特定のコメントに返信を追加します

    引数

    • commentId: string

      返信が追加されるコメントのID

    • reply: IComment

      返信のコメントオブジェクト。参照 IComment

      gcComment.replyToComment('id_1', comment);

    戻り値 void

sort

  • sort(sortInfo: SortInfo): void

  • 読み込んだコメントをソートします

    引数

    • sortInfo: SortInfo

      ソート条件。 参照 SortInfo

      gcComment.sort({isDesc: true, sortBy: GC.InputMan.GcCommentSortBy.UpdateTime});

    戻り値 void

updateComment

  • updateComment(comment: IComment): void

  • 指定したコメントを更新します。指定されたcomment.idがGcCommentに追加されていない場合は、発生しません

    引数

    • comment: IComment

      更新されるコメントオブジェクト。参照 IComment

      gcComment.updateComment(comment);

    戻り値 void

静的 getLanguage

  • GcCommentの表示言語を所得します

    戻り値 GcCommentLanguage

    GcCommentの現在の表示言語。参照 GcCommentLanguage

    var lang = GC.InputMan.GcComment.getLanguage();

静的 setLanguage

  • GcCommentの表示言語を設定します（GcCommentが初期化される前に呼び出す必要があります）

    引数

    • lang: GcCommentLanguage

      GC.InputMan.GcCommentLanguage列挙型を設定します。参照 GcCommentLanguage

      GC.InputMan.GcComment.setLanguage(GC.InputMan.GcCommentLanguage.JA);

    戻り値 void

静的 setResource

イベント

AfterExecuteCommand

AfterExecuteCommand: (args: ExecuteCommandArgs): void

GcCommentでコマンドが実行した後に発生します

param

イベントデータ

型宣言

AfterFirstLoad

AfterFirstLoad: (): void

GcCommentが初回コメントを読み込んだ後に発生します

型宣言

    • (): void

    • 戻り値 void

BeforeExecuteCommand

BeforeExecuteCommand: (args: ExecuteCommandArgs): void

GcCommentでコマンドが実行する前に発生します

param

イベントデータ

型宣言

BeforeFirstLoad

BeforeFirstLoad: (): void

GcCommentが初回コメントを読み込む前に発生します

型宣言

    • (): void

    • 戻り値 void

CreateEditor

CreateEditor: (args: CreateEditorArgs): ICommentEditor

commentEditorが作成される前に発生します

param

イベントデータ

型宣言

EditorCreated

EditorCreated: (args: EditorCreatedArgs): void

commentEditorが作成された後に発生します

param

イベントデータ

型宣言

PreprocessError

PreprocessError: (args: PreprocessErrorArgs): void

dataSourceのconfig設定とGcCommentのデータフェッチにエラーが発生するときに発生します

param

イベントデータ

型宣言