Виджет деловых сообщений

Библиотека JavaScript виджета «Бизнес-сообщения» программно инициализирует и включает отслеживание взаимодействия с виджетами «Бизнес-сообщения».

Функции и свойства

Функции и свойства обеспечивают детальный контроль над инициализацией элементов.

Инициализировать

Динамически инициализирует элемент HTML для использования в качестве виджета бизнес-сообщений. Функция возвращает обещание, которое разрешается после завершения инициализации.

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

• HTMLElement — это элемент, который нужно инициализировать как виджет.
• {agentId, context} — это значения HTML-атрибутов data-bm-widget-agent-id и data-bm-widget-context .

Сканировать

Сканирует документ на наличие любых элементов HTML, содержащих атрибут data-bm-widget-agent-id и преобразует эти элементы в виджеты Business Messages. window.bmwidget.scan() автоматически вызывается при загрузке страницы и во время инициализации скрипта.

window.bmwidget.scan():void

Поддерживается

Логический флаг только для чтения, который имеет значение true, если устройство пользователя поддерживает бизнес-сообщения.

window.bmwidget.supported:boolean

События

Библиотека запускает события для элементов HTML, которые она инициализирует как виджеты Business Messages.

Связать успех

Событие bm-widget-bind-success срабатывает, когда элемент HTML успешно привязан как виджет бизнес-сообщений и готов к использованию.

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

Сбой привязки

Событие bm-widget-bind-fail срабатывает, когда попытка привязки к элементу HTML не удалась. Это может произойти из-за невозможности проверки URL-адреса или из-за общей ошибки при получении элемента HTML. Не удалось выполнить проверку, если URL-адрес не зарегистрирован в качестве точки входа виджета Business Messages или устройство пользователя не поддерживается. Свойство event.data подробно описывает причину сбоя.

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

Триггер намерения

Событие bm-widget-intent-trigger срабатывает, когда пользователь касается инициализированной точки входа виджета Business Messages. Это событие сигнализирует о касании, но не указывает, успешно ли инициализирована диалоговая поверхность Business Messages.

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