Widget Business Messages

La libreria JavaScript del widget di Business Messages inizializza e attiva in modo programmatico il monitoraggio del coinvolgimento per i widget di Business Messages.

Funzioni e proprietà

Le funzioni e le proprietà forniscono un controllo granulare sull'inizializzazione degli elementi.

Init

Inizializza dinamicamente un elemento HTML da utilizzare come widget di Business Messages. La funzione restituisce una promessa che si risolve al termine dell'inizializzazione.

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

• HTMLElement è l'elemento da inizializzare come widget.
• {agentId, context} sono i valori degli attributi HTML data-bm-widget-agent-id e data-bm-widget-context.

Analizza

Analizza il documento per individuare gli elementi HTML che contengono un attributo data-bm-widget-agent-id e li converte in widget di Business Messages. window.bmwidget.scan() viene chiamata automaticamente al caricamento pagina e durante l'inizializzazione dello script.

window.bmwidget.scan():void

Supportato

Flag booleano di sola lettura valido se il dispositivo dell'utente supporta Business Messages.

window.bmwidget.supported:boolean

Eventi

La libreria attiva gli eventi negli elementi HTML che inizializza come widget di Business Messages.

Associazione riuscita

L'evento bm-widget-bind-success viene attivato quando un elemento HTML viene associato correttamente come widget di Business Messages ed è pronto per l'uso.

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

Associazione non riuscita

L'evento bm-widget-bind-fail si attiva quando un tentativo di associazione a un elemento HTML non riesce. Ciò può dipendere da una mancata convalida dell'URL o da un errore generale di recupero dell'elemento HTML. La convalida non si verifica se l'URL non è stato registrato come punto di ingresso del widget Business Messages o il dispositivo dell'utente non è supportato. La proprietà event.data descrive la causa dell'errore.

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

Trigger di intent

L'evento bm-widget-intent-trigger si attiva quando un utente tocca un punto di ingresso con un widget Business Messages inizializzato. Questo evento segnala un tocco, ma non indica se la piattaforma di conversazione di Business Messages è stata inizializzata correttamente.

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