提供: Bright Pattern Documentation
移動先: 案内検索
• English

onGetKnowledgeBaseArticle

このハンドラーは、Communicatorウィジェットに表示するためのナレッジベース(KB)記事の完全なデータを取得するために使用されます。ユーザーが検索結果の項目の一つをクリックすると、onsearchKnowledgeBaseデータに基づいてその記事が表示されます。
:データを返すハンドラーを複数設定した場合、最後のハンドラーからの結果のみが使用されます。

リクエスト

構文

on('ON_GET_KNOWLEDGE_BASE_ARTICLE', handler: OnGetKnowledgeBaseArticle): void


type OnGetKnowledgeBaseArticle = (articleId: string) => ExternalKBArticle | null | Promise<EXTERNALKBARTICLE | null>

type ExternalKBArticle = {

id: string

タイトル: string

キーワード: string

応答: string

メモ: string

言語: string

作成者: string

最終編集者: string

    customFields: Record<string, string>

}


パラメータ

パラメータ パラメータの値 データ型 オプション/必須 説明
articleId 文字列 必須 onsearchKnowledgeBase の戻りオブジェクト ExternalKBSearchResult から取得された記事の id です。


戻り値

オブジェクト オブジェクトの値 データ型 オプションですか?(はい/いいえ) 値の説明
ExternalKBArticle
はい
id 文字列 記事の一意のidです。通常、リクエストパラメータの articleId と同一です
タイトル 文字列 ナレッジベース記事のタイトルです。
キーワード 文字列 ナレッジベース記事のキーワード
応答 文字列 ナレッジベース記事のコンテンツ。HTMLを含めることができます。
メモ 文字列 ナレッジベースの記事に関連する使用上の注意事項やその他追加情報
言語 文字列 ナレッジベース記事の言語
作成者 文字列 ナレッジベース記事の作成者(つまり、特定のナレッジベース記事の作成者である外部システムのユーザーのID)です。
lastEditedByUser 文字列 ナレッジベース記事を最後に編集したユーザーの名前
customFields Record<string, string> ナレッジベースの記事に関連する補足情報
null Y なお、ExternalKBArticleの代わりにnullの値が返される場合があります。articleIdと適合する記事が見つからない場合、nullの値が返されます。
< 前へ | 次へ >