Widget do Business Messages

A biblioteca JavaScript do widget Business Messages inicializa programaticamente ativa o acompanhamento do engajamento para widgets do Business Messages.

Funções e propriedades

As funções e propriedades fornecem um controle refinado sobre o elemento inicialização do sistema.

Init

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

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

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

Verificação

Verifica o documento em busca de qualquer elemento HTML que contenha um data-bm-widget-agent-id e converte esses elementos em Business Widgets de mensagens. window.bmwidget.scan() é chamado automaticamente no carregamento de página. e durante a inicialização do script.

window.bmwidget.scan():void

Compatível

Sinalização booleana somente leitura que é verdadeira se o dispositivo do usuário for compatível. Business Messages.

window.bmwidget.supported:boolean

Eventos

A biblioteca aciona eventos nos elementos HTML que inicializa como Widgets do Business Messages.

Vinculação concluída

O evento bm-widget-bind-success é acionado quando um elemento HTML é vinculado como widget do Business Messages e 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 HTML falha. Isso pode acontecer devido a uma falha na validação do URL ou devido a uma falha geral no recebimento do elemento HTML. Falha ao validar acontece se o URL não foi registrado como entrada do widget do Business Messages ou o dispositivo do usuário não é compatível. Detalhes da propriedade event.data a causa da falha.

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

Gatilho de intent

O evento bm-widget-intent-trigger é acionado quando um usuário toca em um Perfil da Empresa inicializado Ponto de entrada do widget Mensagens. Este evento sinaliza 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);
});