Widget Business Messages

La bibliothèque JavaScript du widget Business Messages initialise et initialise permet le suivi de l'engagement pour les widgets Business Messages.

Fonctions et propriétés

Les fonctions et les propriétés permettent de contrôler précisément l'élément l'initialisation.

Init

Il initialise dynamiquement un élément HTML à utiliser comme Widget Business Messages. La fonction renvoie une promesse qui se résout lorsque est terminée.

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

• HTMLElement est l'élément à initialiser en tant que widget.
• {agentId, context} correspond aux valeurs de data-bm-widget-agent-id et data-bm-widget-context attributs HTML.

Rechercher

Analyse le document à la recherche d'éléments HTML contenant un élément data-bm-widget-agent-id et convertit ces éléments en valeurs de type "Business" Widgets Messages. window.bmwidget.scan() est automatiquement appelé lors du chargement de la page et pendant l'initialisation du script.

window.bmwidget.scan():void

Compatible

Indicateur booléen en lecture seule qui est vrai si l'appareil de l'utilisateur prend en charge Business Messages.

window.bmwidget.supported:boolean

Événements

La bibliothèque déclenche des événements sur les éléments HTML qu'elle initialise en tant que Widgets Business Messages.

Liaison réussie

L'événement bm-widget-bind-success se déclenche lorsqu'un élément HTML est lié en tant que widget Business Messages et prêt à être utilisé.

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

Échec de la liaison

L'événement bm-widget-bind-fail se déclenche lorsqu'une tentative de liaison à un code HTML est défaillant. Cela peut se produire si la validation de l'URL ou en raison d'un échec général d'obtention de l'élément HTML. Échec de la validation se produit si l'URL n'a pas été enregistrée en tant qu'entrée de widget Business Messages ou si l'appareil de l'utilisateur n'est pas pris en charge. Détails de la propriété event.data la cause de l'échec.

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

Déclencheur d'intent

L'événement bm-widget-intent-trigger se déclenche lorsqu'un utilisateur appuie sur une entreprise initialisée. Point d'entrée du widget Messages. Cet événement indique qu'un utilisateur a appuyé dessus, mais ne l'indique pas. si la surface de conversation Business Messages a bien été initialisée.

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