Widget de Mensajes de negocios

La biblioteca de JavaScript de widgets de Business Messages inicializa y habilita de forma programática el seguimiento de la participación de los widgets de Business Messages.

Funciones y propiedades

Las funciones y las propiedades proporcionan un control detallado sobre la inicialización de los elementos.

Init

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

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

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

Análisis

Analiza el documento en busca de elementos HTML que contengan un atributo data-bm-widget-agent-id y los convierta en widgets de Business Messages. Se llama a window.bmwidget.scan() de forma automática durante la carga de la página y durante la inicialización de la secuencia de comandos.

window.bmwidget.scan():void

Admitido

Marca booleana de solo lectura que es verdadera si el dispositivo del usuario es compatible con Business Messages.

window.bmwidget.supported:boolean

Eventos

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

Se vinculó correctamente

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

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

Error de vinculación

El evento bm-widget-bind-fail se activa cuando falla un intento de vinculación a un elemento HTML. Esto puede suceder porque no se pudo validar la URL o porque no se pudo obtener el elemento HTML. No se puede validar si la URL no se registró como punto de entrada del widget de Business Messages o si el dispositivo del usuario no es compatible. La propiedad event.data detalla la causa del error.

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 un punto de entrada inicializado del widget de Business Messages. Este evento señala un toque, pero no indica si se inicializó correctamente la superficie de conversación de Business Messages.

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