Widget do Business Messages

A biblioteca JavaScript do widget Business Messages é inicializada de maneira programática e ativa o rastreamento de engajamento para widgets do Business Messages.

Funções e propriedades

As funções e propriedades fornecem um controle refinado sobre a inicialização de elementos.

Init

Inicializa dinamicamente um elemento HTML para ser usado como um widget do Business Messages. A função retorna uma promessa que será resolvida quando a inicialização for concluída.

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

• HTMLElement é o elemento a ser inicializado como um widget.
• {agentId, context} são os valores dos atributos HTML data-bm-widget-agent-id e data-bm-widget-context.

Verificação

Verifica o documento em busca de elementos HTML que contenham um atributo data-bm-widget-agent-id e os converte em widgets de mensagens comerciais. window.bmwidget.scan() é chamado automaticamente no carregamento da página e durante a inicialização do script.

window.bmwidget.scan():void

Compatível

Sinalizador booleano somente leitura que será verdadeiro se o dispositivo do usuário for compatível com o Business Messages.

window.bmwidget.supported:boolean

Eventos

A biblioteca aciona eventos em elementos HTML inicializados como widgets do Business Messages.

Vincular o sucesso

O evento bm-widget-bind-success é acionado quando um elemento HTML é vinculado como um widget do Business Messages e está pronto para uso.

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

Falha na vinculação

O evento bm-widget-bind-fail é acionado quando uma tentativa de vinculação a um elemento HTML falha. Isso pode acontecer devido a uma falha na validação do URL ou por uma falha geral no recebimento do elemento HTML. A validação não acontece se o URL não tiver sido registrado como um ponto de entrada do widget Business Messages ou se o dispositivo do usuário não for compatível. A propriedade event.data detalha a causa da falha.

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

Acionador de intent

O evento bm-widget-intent-trigger é acionado quando um usuário toca em um ponto de entrada do widget Business Messages inicializado. Esse evento indica um toque, mas não indica se a superfície de conversa do Business Messages foi inicializada.

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