Widget für Business Messages

Die JavaScript-Bibliothek des Business Messages-Widgets initialisiert und aktiviert Engagement-Tracking für Business Messages-Widgets.

Funktionen und Attribute

Funktionen und Attribute ermöglichen eine präzise Steuerung der Elementinitialisierung.

Init

Initialisiert ein HTML-Element, das als Business Messages-Widget verwendet werden soll, dynamisch. Die Funktion gibt ein Versprechen zurück, das nach Abschluss der Initialisierung aufgelöst wird.

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

• HTMLElement ist das Element, das als Widget initialisiert werden soll.
• {agentId, context} sind die Werte für die HTML-Attribute data-bm-widget-agent-id und data-bm-widget-context.

Scannen

Scannt das Dokument nach HTML-Elementen, die ein data-bm-widget-agent-id-Attribut enthalten, und konvertiert diese Elemente in Business Messages-Widgets. window.bmwidget.scan() wird beim Seitenaufbau und während der Skriptinitialisierung automatisch aufgerufen.

window.bmwidget.scan():void

Unterstützt

Boolesches boolesches Flag, das „true“ ist, wenn das Gerät des Nutzers Business Messages unterstützt.

window.bmwidget.supported:boolean

Events

Die Bibliothek löst Ereignisse für HTML-Elemente aus, die als Business Messages-Widgets initialisiert werden.

Bindung erfolgreich

Das Ereignis bm-widget-bind-success wird ausgelöst, wenn ein HTML-Element erfolgreich als Business Messages-Widget gebunden und einsatzbereit ist.

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

Bindung fehlgeschlagen

Das Ereignis bm-widget-bind-fail wird ausgelöst, wenn ein Bindungsversuch an ein HTML-Element fehlschlägt. Dies kann daran liegen, dass die URL nicht validiert werden konnte oder dass das HTML-Element allgemein nicht abgerufen werden konnte. Die Validierung tritt auf, wenn die URL nicht als Einstiegspunkt für das Business Messages-Widget registriert wurde oder das Gerät des Nutzers nicht unterstützt wird. Das Attribut event.data gibt die Fehlerursache an.

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

Intent-Trigger

Das Ereignis bm-widget-intent-trigger wird ausgelöst, wenn ein Nutzer auf einen initialisierten Einstiegspunkt für das Widget „Nachrichten“ tippt. Dieses Ereignis gibt ein Tippen aus, zeigt aber nicht an, ob die Business Messages-Unterhaltungsoberfläche erfolgreich initialisiert wurde.

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