Widget Business Messages

La bibliothèque JavaScript de widgets Business Messages s'initialise et active 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'initialisation des éléments.

Init

Initialise de manière dynamique un élément HTML à utiliser comme widget Business Messages. La fonction renvoie une promesse qui se résout une fois l'initialisation terminée.

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

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

Analyse

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

window.bmwidget.scan():void

Autorisé

Indicateur booléen en lecture seule défini sur "true" si l'appareil de l'utilisateur est compatible avec 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 correctement 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 élément HTML échoue. Cela peut se produire à cause d'un échec de validation de l'URL ou d'un échec général d'obtention de l'élément HTML. Échec de la validation si l'URL n'a pas été enregistrée en tant que point d'entrée du widget Business Messages ou si l'appareil de l'utilisateur n'est pas compatible. La propriété event.data détaille 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 un point d'entrée du widget Business Messages initialisé. Cet événement signale un geste, mais n'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);
});