Widget für Business Messages

Die JavaScript-Bibliothek des Business Messages-Widgets wird programmatisch initialisiert und aktiviert das Interaktions-Tracking für Business Messages-Widgets.

Funktionen und Attribute

Funktionen und Eigenschaften ermöglichen eine präzise Steuerung von Elementen die Initialisierung bei.

Init

Initialisiert dynamisch ein HTML-Element, das als Business Messages-Widget Die Funktion gibt ein Versprechen zurück, das aufgelöst wird, wenn die Initialisierung abgeschlossen ist.

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

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

Scannen

Scannt das Dokument nach HTML-Elementen, die Folgendes enthalten: data-bm-widget-agent-id-Attribut und wandelt diese Elemente in ein Unternehmenskonto um. Messages-Widgets. window.bmwidget.scan() wird beim Seitenaufbau automatisch aufgerufen und während der Initialisierung des Skripts.

window.bmwidget.scan():void

Unterstützt

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

window.bmwidget.supported:boolean

Ereignisse

Die Bibliothek löst Ereignisse für HTML-Elemente aus, mit denen sie initialisiert wird Business Messages-Widgets

Bindung erfolgreich

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

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

Bindung fehlgeschlagen

Das Ereignis bm-widget-bind-fail wird ausgelöst, wenn versucht wird, eine Bindung an einen HTML-Code herzustellen scheitert. Dies kann an einer fehlerhaften Validierung der URL oder an weil beim Abrufen des HTML-Elements ein allgemeiner Fehler aufgetreten ist. Fehler bei der Validierung wenn die URL nicht als Business Messages-Widget-Eintrag registriert wurde oder das Gerät des Nutzers wird nicht unterstützt. Details zur event.data-Eigenschaft Fehlerursache ermitteln.

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 ein initialisiertes Unternehmen tippt Einstiegspunkt für das Widget "Messages". Bei diesem Ereignis wird ein Tippen erkannt, aber es wird nicht angezeigt Gibt an, ob die Konversationsoberfläche von Business Messages erfolgreich initialisiert wurde.

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