提供: Bright Pattern Documentation
• English
onOpenRecord
Communicatorウィジェットは、特定のCRMレコードを表示する必要がある場合に、このイベントを送信します。これは、以下の複数の場面で発生する可能性があります:
- シナリオ内で、CRM画面ポップアップブロックがインタラクション用に設定されている場合。
- ユーザーがウィジェットの「履歴」からCRMレコードのリンクをクリックした場合。
- ユーザーがインタラクション中に「クイックレコードアクセス」ポップアップからレコードをクリックした場合。
- ユーザーがインタラクション中に「関連レコード」タブからレコードをクリックした場合。
リクエスト
構文
| on('ON_OPEN_RECORD', handler: OnOpenRecordHandler): void
type InteractionAssociatedObjectData = { id: string type: string displayName: string displayType: string customFields: Record<STRING, string> } type OpenRecordOptions = { inNewTab: boolean ソース: "ユーザー" | "シナリオ" } |
パラメータ
| パラメータ | パラメータ値 | データ型 | オプション/必須 | 説明 |
| レコード | ||||
| オブジェクト | 必須 | 開くべきレコードデータ | ||
| id | 文字列 | 必須 | レコードのid | |
| 入力 | 文字列 | 必須 | レコードタイプ(連絡先、ケース、タスクなど) | |
| displayName | 文字列 | 必須 | レコードの表示名 | |
| displayType | 文字列 | 必須 | レコードの表示タイプ | |
| customFields | オブジェクト | 必須 | 保持したいレコードに関する追加情報 | |
| interactionId | 文字列 | オプション | アクションに関連付けられているインタラクションの id | |
| オプション | ||||
| オブジェクト | オプション | アクションの設定 | ||
| inNewTab | ブール値 | 必須 | レコードを新しいタブで開くかどうかを指定します | |
| ソース | 文字列 | 必須 | このパラメータにより、イベントがユーザーの直接操作(クリック時)によって発生したのか、それとも自動的に(シナリオから)発生したのかを判別できます。 |
リクエスト例
adApi.on("ON_OPEN_RECORD", function (record, interactionId, options) {
if (options.inNewTab) {
openCrmRecordWindow(record.id);
} else {
switchScreenToCrmRecord(record.id);
}
});
戻り値
ハンドラは値または Promise (SyncAsyncResult) を返すことができます。通常、戻り値は使用されません。