Описание методов и настроек
Обновлено: 30 октября 2026
В этой статье приведено описание методов, событий и параметров веб-виджета push-уведомлений edna.
Методы window.ednaWidget.publicMethods
Методы и события виджета доступны через window.ednaWidget.publicMethods. Подписка на события выполняется через window.ednaWidget.Emitter.
Методы
| Метод | Назначение | Код | Основные параметры |
|---|---|---|---|
init | Инициализирует виджет. В метод передаётся VAPID-ключ. | window.ednaWidget.publicMethods.init(vapidKey: string, options: object): void | Параметры:
- vapidKey — публичный VAPID-ключ, сгенерированный на платформе edna;
- options — необязательные параметры инициализации. |
onDeviceAddressChanged | Событие изменения deviceAddress устройства. | 'onDeviceAddressChanged' | |
onError | Событие ошибки виджета. Код ошибки рекомендуется передать в систему краш-аналитики как non-fatal. | 'onError' | |
getDeviceUid | Возвращает текущий deviceUid. | window.ednaWidget.publicMethods.getDeviceUid: () => string | |
getDeviceAddress | Возвращает текущий deviceAddress. | window.ednaWidget.publicMethods.getDeviceAddress: () => string | |
checkPermitAndAsk | Проверяет разрешение пользователя на показ push-уведомлений. Если разрешения нет, вызывает showAskingPopup. Если уведомления разрешены, завершается без результата. | window.ednaWidget.publicMethods.checkPermitAndAsk: () => void | |
showAskingPopup | Показывает всплывающее окно с запросом разрешения на push-уведомления. Если уведомления запрещены, вызывает showPermissionDeniedPopup. | window.ednaWidget.publicMethods.showAskingPopup: () => void | |
showPermissionDeniedPopup | Показывает всплывающее окно с инструкцией по включению push-уведомлений. | window.ednaWidget.publicMethods.showPermissionDeniedPopup: () => void | |
getWorkerState | Асинхронно возвращает статус сервис-воркера и сведения о подписке на push-облако. Состав объекта описан ниже. | window.ednaWidget.publicMethods.getWorkerState: () => object | |
resetToken | Сбрасывает токен устройства. | window.ednaWidget.publicMethods.resetToken: () => void | |
push | Событие получения уведомления. | 'push' | |
markMessagesAsRead | Отмечает одно или несколько сообщений как прочитанные. | window.ednaWidget.publicMethods.markMessagesAsRead([readMessageId: string]) => void | Параметр:
- readMessageId — идентификатор прочитанного сообщения. Можно передать несколько идентификаторов. |
Объект getWorkerState
Метод getWorkerState() возвращает объект со статусом сервис-воркера и данными подписки.
| Параметр | Тип | Описание |
|---|---|---|
status | string | Статус воркера.
Возможные значения: - SW_IS_NOT_SUPPORTED — браузер не поддерживает service worker;
- SW_IS_NOT_REGISTERED — браузер поддерживает service worker, но нужный воркер не найден;
- SW_REGISTERED — браузер поддерживает service worker, нужный воркер найден. |
workerState | string | Состояние воркера.
Возможные значения: - installing — устанавливается;
- waiting — ожидает активации;
- activating — активируется;
- activated — активирован;
- redundant — устарел;
- unknown — состояние неизвестно. |
pushSubscriptionEndpoint | string | Конечная точка подписки. |
pushSubscriptionServerApplicationKey | string | Ключ сервера подписки. |
isSubscribed | boolean | Признак активной подписки. |
scriptURL | string | Адрес скрипта сервис-воркера. |
Класс Emitter
Класс window.ednaWidget.Emitter управляет подписками на события виджета.
Методы класса Emitter
| Метод | Назначение | Код | Основные параметры |
|---|---|---|---|
events | Объект с событиями и подписанными на них коллбэками. | window.ednaWidget.Emitter.events | |
subscribe | Подписывает коллбэк на событие. | window.ednaWidget.Emitter.subscribe(event: string, callback: TListener): void | Параметры:
- event — имя события;
- callback — функция, которая вызывается при событии. |
unsubscribe | Отписывает коллбэк от события. | window.ednaWidget.Emitter.unsubscribe(event: string, callback: TListener): void | Параметры:
- event — имя события;
- callback — функция, которую нужно отписать. |
clearEvent | Удаляет все коллбэки, подписанные на событие. | window.ednaWidget.Emitter.clearEvent(event: string): void | Параметр:
- event — имя события. |
Примеры
window.ednaWidget.Emitter.subscribe('onDeviceAddressChanged', (deviceAddresses) => {
console.log('"onDeviceAddressChanged" event', deviceAddresses);
});
window.ednaWidget.Emitter.subscribe('onError', (error) => {
console.log('"onError" event', error);
});
window.ednaWidget.Emitter.subscribe('push', (event) => {
console.log('push param', event);
});
Параметры виджета
Параметры ниже задают домен, версию, ключи и режим регистрации сервис-воркера. Часть из них записывается в localStorage до инициализации, vapidKey и options передаются в init().
| Параметр | Тип | Описание |
|---|---|---|
appPackage | string | Доменное имя сайта, к которому подключается виджет, без протокола. Например, example.com. |
appVersion | string | Версия сборки сайта. Используется для анализа доставки сообщений на стороне edna. Размещается в localStorage. |
providerUid | string | Уникальный ключ приложения. Виджет создаёт его автоматически, задавать вручную не требуется. Размещается в localStorage. |
ednaWorkerPath | string | Путь к файлу сервис-воркера, если он расположен не в корневом каталоге. Размещается в localStorage. |
isWorkerManualRegistration | boolean | Флаг ручной регистрации сервис-воркера. Если значение false или параметр не указан, виджет регистрирует сервис-воркер при инициализации. Если значение true, сервис-воркер нужно зарегистрировать до инициализации виджета. |
customWorkerScope | string | Скоуп сервис-воркера при isWorkerManualRegistration=true. По умолчанию используется глобальный скоуп /. |
vapidKey | string | Публичный VAPID-ключ, сгенерированный на платформе edna. Передаётся в init(). |
logEnabled | boolean | Включает расширенное логирование. По умолчанию true в тестовых сборках и false в промышленной среде. Размещается в localStorage. |
options | object | Необязательные параметры инициализации виджета. Передаются вторым аргументом init(). |
isSentryOn | boolean | Флаг отправки событий аналитики. |
overrideBaseUrl | string | Переопределяет базовый адрес веб-виджета. |
resubscribeInterval | number | Периодичность обновления подписки виджета в секундах. Значение по умолчанию — 2 недели. |