ビジネス メッセージ ウィジェットの JavaScript ライブラリは、プログラムによって初期化され、ビジネス メッセージ ウィジェットのエンゲージメント トラッキングを有効にします。
関数とプロパティ
関数とプロパティにより、要素の初期化をきめ細かく制御できます。
init
ビジネス メッセージ ウィジェットとして使用する HTML 要素を動的に初期化します。この関数は、初期化が完了すると解決される Promise を返します。
window.bmwidget.init(HTMLElement, {agentId, context}):Promise
HTMLElement
は、ウィジェットとして初期化する要素です。{agentId, context}
は、HTML 属性data-bm-widget-agent-id
とdata-bm-widget-context
の値です。
スキャン
data-bm-widget-agent-id
属性を含む HTML 要素についてドキュメントをスキャンし、それらの要素をビジネス メッセージ ウィジェットに変換します。window.bmwidget.scan()
は、ページの読み込み時とスクリプトの初期化時に自動的に呼び出されます。
window.bmwidget.scan():void
サポート対象
ユーザーのデバイスがビジネス メッセージをサポートしている場合は、読み取り専用のブール値フラグです。
window.bmwidget.supported:boolean
イベント
このライブラリは、Business Messages ウィジェットとして初期化する HTML 要素に対してイベントをトリガーします。
バインドの成功
bm-widget-bind-success
イベントは、HTML 要素がビジネス メッセージ ウィジェットとして正常にバインドされ、使用できる状態になったときにトリガーされます。
domNode.addEventListener('bm-widget-bind-success', (event) => {
console.log(event.data);
});
バインドの失敗
bm-widget-bind-fail
イベントは、HTML 要素にバインドできなかったときにトリガーされます。URL の検証で不合格だったり、一般的な HTML 要素の取得に失敗した可能性があります。URL がビジネス メッセージ ウィジェットのエントリ ポイントとして登録されていない場合や、ユーザーのデバイスがサポートされていない場合は、検証で不合格になります。event.data
プロパティは、失敗の原因の詳細を示します。
domNode.addEventListener('bm-widget-bind-fail', (event) => {
console.log(event.data);
});
インテント トリガー
bm-widget-intent-trigger
イベントは、初期化されたビジネス メッセージ ウィジェットのエントリ ポイントをユーザーがタップするとトリガーされます。このイベントはタップを通知しましたが、ビジネス メッセージの会話サーフェスが正常に初期化されたかどうかは示されません。
domNode.addEventListener('bm-widget-intent-trigger', (event) => {
console.log(event.data);
});