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 inicjowaniem elementu.

Inicjacja

Dynamicznie inicjuje element HTML, który ma być używany jako widżet Business Messages. Funkcja zwraca obietnicę, która zostaje zakończona po zakończeniu inicjowania.

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

• HTMLElement to element inicjujący jako widżet.
• {agentId, context} to wartości atrybutów HTML data-bm-widget-agent-id i data-bm-widget-context.

Skan

Skanuje wszystkie elementy HTML zawierające atrybut data-bm-widget-agent-id i konwertuje te elementy na widżety Business Messages. window.bmwidget.scan() jest automatycznie wywoływany podczas wczytywania strony i w trakcie inicjowania skryptu.

window.bmwidget.scan():void

Obsługiwana

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

window.bmwidget.supported:boolean

Zdarzenia

Biblioteka wywołuje zdarzenia w elementach HTML, które inicjują jako widżety Business Messages.

Powiązanie zakończone

Zdarzenie bm-widget-bind-success jest wywoływane, gdy element HTML jest powiązany jako widżet Business Messages i jest gotowy do użycia.

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

Powiązanie nieudane

Zdarzenie bm-widget-bind-fail jest wywoływane, gdy próba powiązania z elementem HTML kończy się niepowodzeniem. Może się tak zdarzyć z powodu nieudanej weryfikacji adresu URL lub ogólnej sytuacji, w której nie można pobrać elementu HTML. Jeśli adres URL nie zostanie zarejestrowany jako punkt wejścia widżetu Business Messages lub urządzenie użytkownika nie będzie obsługiwane, może wystąpić błąd. Właściwość event.data podaje przyczynę niepowodzenia.

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

Aktywator intencji

Zdarzenie bm-widget-intent-trigger jest uruchamiane, gdy użytkownik kliknie zainicjowany punkt wejścia widżetu Business Messages. To zdarzenie sygnalizuje kliknięcie, ale nie wskazuje, czy okno rozmów w Business Messages zostało zainicjowane.

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