Библиотека JavaScript виджета «Бизнес-сообщения» программно инициализирует и включает отслеживание вовлеченности для виджета «Бизнес-сообщение».
Функции и свойства
Функции и свойства обеспечивают детальное управление инициализацией элемента.
В этом
Динамически инициализирует HTML-элемент для использования в качестве виджета Business Messages. Функция возвращает обещание, которое разрешается после завершения инициализации.
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 успешно привязывается как виджет Business Messages и готов к использованию.
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);
});