Business Messages 微件

Business Messages widget JavaScript 库可以编程方式初始化 Business Messages widget 并启用互动跟踪。

函数和属性

函数和属性可对元素初始化进行精细控制。

Init

动态初始化要用作 Business Messages widget 的 HTML 元素。该函数返回一个在初始化完成后解析的 promise。

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 widget 的 HTML 元素触发事件。

绑定成功

当 HTML 元素作为 Business Messages 微件成功绑定并可供使用时，会触发 bm-widget-bind-success 事件。

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

绑定失败

bm-widget-bind-fail 事件会在尝试绑定到 HTML 元素失败时触发。这可能是因为网址验证失败，或者无法获取 HTML 元素。如果相应网址尚未注册为 Business Messages widget 入口点或用户的设备不受支持，则表示验证失败。 event.data 属性详细说明了失败的原因。

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

intent 触发器

当用户点按初始化的 Business Messages 微件入口点时，系统会触发 bm-widget-intent-trigger 事件。此事件表示点按操作，但不会指明 Business Messages 对话界面是否已成功初始化。

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