Widget Business Messages

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

Funzioni e proprietà

Le funzioni e le proprietà offrono un controllo granulare sugli elementi. durante l'inizializzazione.

Init

Inizializza dinamicamente un elemento HTML da utilizzare come Widget Business Messages. La funzione restituisce una promessa che si risolve quando l'inizializzazione è completa.

window.bmwidget.init(HTMLElement, {agentId, context}):Promise
  • HTMLElement è l'elemento da inizializzare come widget.
  • {agentId, context} sono i valori di data-bm-widget-agent-id e data-bm-widget-context attributi HTML.

Scansione

Esegue la scansione del documento per verificare la presenza di eventuali elementi HTML contenenti un data-bm-widget-agent-id e converte questi elementi in business Widget di Messaggi. window.bmwidget.scan() viene chiamato automaticamente al caricamento pagina e durante l'inizializzazione degli script.

window.bmwidget.scan():void

Supportato

Flag booleano di sola lettura che risulta true se il dispositivo dell'utente supporta Business Messages.

window.bmwidget.supported:boolean

Eventi

La libreria attiva gli eventi negli elementi HTML che vengono inizializzati come Widget di Business Messages.

Associazione riuscita

L'evento bm-widget-bind-success viene attivato quando un elemento HTML viene associato correttamente come widget 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 viene attivato quando un tentativo di associazione a un codice HTML non riesce. Ciò può accadere a causa di un errore di convalida dell'URL o a causa di un errore generale di recupero dell'elemento HTML. Convalida non riuscita si verifica se l'URL non è stato registrato come voce del widget Business Messages o il dispositivo dell'utente non è supportato. Dettagli della proprietà event.data causa dell'errore.

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

Trigger di intent

L'evento bm-widget-intent-trigger viene attivato quando un utente tocca un'attività inizializzata Punto di accesso del widget Messaggi. Questo evento segnala un tocco, ma non se la piattaforma di conversazione di Business Messages è stata inizializzata correttamente.

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