Widżet Business Messages

Biblioteka JavaScript widżetu Business Messages automatycznie inicjuje i włącza śledzenie zaangażowania w widżetach Business Messages.

Funkcje i właściwości

Funkcje i właściwości zapewniają szczegółową kontrolę nad elementem jego zainicjowanie.

Init

Dynamicznie inicjuje element HTML, który ma być używany jako Widżet Business Messages. Funkcja zwraca obietnicę zrealizowana, gdy ukończono inicjalizację.

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

• HTMLElement to element, który ma zostać zainicjowany jako widżet.
• {agentId, context} to wartości dla data-bm-widget-agent-id i Atrybuty HTML: data-bm-widget-context.

Skanuj

Skanuje dokument pod kątem wszystkich elementów HTML zawierających data-bm-widget-agent-id i przekształca te elementy w wartość Business Widżety wiadomości. Pole window.bmwidget.scan() jest wywoływane automatycznie podczas wczytywania strony i inicjowania skryptu.

window.bmwidget.scan():void

Obsługiwane

Flaga wartości logicznej tylko do odczytu, która ma wartość prawda, jeśli urządzenie użytkownika obsługuje Business Messages.

window.bmwidget.supported:boolean

Wydarzenia

Biblioteka wywołuje zdarzenia w elementach HTML inicjowanych jako Widżety Business Messages.

Powiązanie udane

Zdarzenie bm-widget-bind-success jest wyzwalane, gdy element HTML jest został powiązany z widżetem Business Messages i jest gotowy do użycia.

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

Błąd powiązania

Zdarzenie bm-widget-bind-fail jest wywoływane, gdy próba powiązania z kodem HTML występuje błąd. Może się tak zdarzyć z powodu nieudanej weryfikacji adresu URL lub z powodu ogólnego błędu w pobieraniu elementu HTML. Brak weryfikacji występuje, jeśli adres URL nie został zarejestrowany jako wpis widżetu Business Messages lub urządzenie użytkownika nie jest obsługiwane. Szczegóły właściwości event.data przyczynę niepowodzenia.

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

Aktywator intencji

Zdarzenie bm-widget-intent-trigger jest wywoływane, gdy użytkownik kliknie zainicjowaną firmę Punkt wejścia widżetu wiadomości. To zdarzenie sygnalizuje kliknięcie, ale nie wskazuje informacje o tym, czy platforma do rozmowy z Business Messages została zainicjowana.

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