Widget de Mensajes de negocios

La biblioteca de JavaScript del widget de Business Messages inicializa y habilita el seguimiento de la participación para los widgets de Business Messages.

Funciones y propiedades

Las funciones y propiedades proporcionan un control detallado de inicio.

Init

Inicializa de forma dinámica un elemento HTML para usarlo como un elemento. Widget de Business Messages. La función muestra una promesa que se resuelve cuando se complete la inicialización.

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

• HTMLElement es el elemento que se inicializará como widget.
• {agentId, context} son los valores de data-bm-widget-agent-id y data-bm-widget-context atributos HTML.

Escanear

Analiza el documento en busca de elementos HTML que contengan un elemento el atributo data-bm-widget-agent-id y los convierte en elementos empresariales Widgets de Mensajes. Se llama a window.bmwidget.scan() automáticamente cuando se carga la página y durante la inicialización de secuencias de comandos.

window.bmwidget.scan():void

Compatible

Es una marca booleana de solo lectura que es verdadera si el dispositivo del usuario es compatible Business Messages.

window.bmwidget.supported:boolean

Eventos

La biblioteca activa eventos en los elementos HTML que inicializa como Widgets de Business Messages.

La vinculación se realizó correctamente

El evento bm-widget-bind-success se activa cuando se agrega un elemento HTML se vinculó correctamente como un widget de Business Messages y está lista para usarse.

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

Falla de la vinculación

El evento bm-widget-bind-fail se activa cuando se intenta vincular a un HTML falla. Esto puede suceder debido a un error al validar la URL o debido a una falla general al obtener el elemento HTML. Error en la validación ocurre si la URL no se registró como entrada del widget de Business Messages o el dispositivo del usuario no es compatible. Los detalles de la propiedad event.data la causa de la falla.

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

Activador de intents

El evento bm-widget-intent-trigger se activa cuando un usuario presiona una empresa inicializada Punto de entrada del widget de Mensajes. Este evento indica un toque, pero no indica Si la plataforma de conversación de Business Messages se inicializó correctamente.

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