Business Messages 小工具

Business Messages 小工具 JavaScript 程式庫可透過程式輔助方式初始化並啟用 Business Messages 小工具的參與度追蹤功能。

函式與屬性

函式與屬性可以精細地控制元素初始化。

初始

動態初始化 HTML 元素，做為 Business Messages 小工具使用。函式會傳回一個承諾在初始化完成時解析的承諾。

window.bmwidget.init(HTMLElement, {agentId, context}):Promise

• HTMLElement 是初始化為小工具的元素。
• {agentId, context} 是 data-bm-widget-agent-id 和 data-bm-widget-context HTML 屬性的值。

掃描

掃描文件是否含有任何包含 data-bm-widget-agent-id 屬性的 HTML 元素，並將這些元素轉換成 Business Messages 小工具。window.bmwidget.scan() 會在網頁載入和指令碼初始化期間自動呼叫。

window.bmwidget.scan():void

是否支援

使用者的裝置支援 Business Messages 時，唯讀布林值標記為 true。

window.bmwidget.supported:boolean

事件

這個程式庫會在其初始化為 Business Messages 小工具的 HTML 元素上觸發事件。

繫結成功

當 HTML 元素成功繫結為 Business Messages 小工具，並且可供使用時，就會觸發 bm-widget-bind-success 事件。

domNode.addEventListener('bm-widget-bind-success', (event) => {
  console.log(event.data);
});

繫結失敗

當嘗試繫結至 HTML 元素時，就會觸發 bm-widget-bind-fail 事件。這可能是因為網址驗證失敗，或是無法取得 HTML 元素。如果網址尚未註冊為 Business Messages 小工具進入點，或使用者的裝置不受支援，則無法進行驗證。event.data 屬性會詳細說明失敗原因。

domNode.addEventListener('bm-widget-bind-fail', (event) => {
  console.log(event.data);
});

意圖觸發條件

使用者輕觸初始化的 Business Messages 小工具進入點時，就會觸發 bm-widget-intent-trigger 事件。此事件會輕觸輕觸，但不會指出系統是否已將 Business Messages 對話途徑初始化。

domNode.addEventListener('bm-widget-intent-trigger', (event) => {
  console.log(event.data);
});