提供: Bright Pattern Documentation
• English
onShowScreen
このコールバックは、アクティブなインタラクションに関連付けられた CRM 画面データ（つまり、そのデータが変更された際）を受け取るために使用されます。このコールバックのパラメータには、 setInteractionActiveScreen メソッドで設定したオブジェクトが含まれます。
リクエスト
構文
| on('ON_SHOW_SCREEN', handler: OnShowScreenHandler): void
type OnShowScreenHandler = (screen: InteractionScreen, interactionId?: string) => SyncAsyncResult type InteractionScreen = Record<STRING, string | number | boolean | null | undefined> |
パラメータ
| パラメータ | パラメータ値 | データ型 | オプション／必須 | 説明 |
| screen | オブジェクト | 必須 | setInteractionActiveScreen メソッド経由で、そのインタラクション用に追加された、フラットな（つまり、ネストされていない）オブジェクトデータ | |
| interactionId | 文字列 | オプション | 指定されたオブジェクトが属するインタラクションの id |
リクエスト例
adApi.on("ON_SHOW_SCREEN", (screen: InteractionScreen, interactionId?: string) => {
const openedObjectId = screen.objectId;
openCRMObject({id: openedObjectId});
});
戻り値
ハンドラーは値または Promise (SyncAsyncResult) を返すことができます。通常、戻り値は使用されません。