Перейти к основному содержимому

Описание методов и настроек

Обновлено: 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() возвращает объект со статусом сервис-воркера и данными подписки.

ПараметрТипОписание
statusstringСтатус воркера.
Возможные значения:
- SW_IS_NOT_SUPPORTED — браузер не поддерживает service worker;
- SW_IS_NOT_REGISTERED — браузер поддерживает service worker, но нужный воркер не найден;
- SW_REGISTERED — браузер поддерживает service worker, нужный воркер найден.
workerStatestringСостояние воркера.
Возможные значения:
- installing — устанавливается;
- waiting — ожидает активации;
- activating — активируется;
- activated — активирован;
- redundant — устарел;
- unknown — состояние неизвестно.
pushSubscriptionEndpointstringКонечная точка подписки.
pushSubscriptionServerApplicationKeystringКлюч сервера подписки.
isSubscribedbooleanПризнак активной подписки.
scriptURLstringАдрес скрипта сервис-воркера.

Класс 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().

ПараметрТипОписание
appPackagestringДоменное имя сайта, к которому подключается виджет, без протокола. Например, example.com.
appVersionstringВерсия сборки сайта. Используется для анализа доставки сообщений на стороне edna. Размещается в localStorage.
providerUidstringУникальный ключ приложения. Виджет создаёт его автоматически, задавать вручную не требуется. Размещается в localStorage.
ednaWorkerPathstringПуть к файлу сервис-воркера, если он расположен не в корневом каталоге. Размещается в localStorage.
isWorkerManualRegistrationbooleanФлаг ручной регистрации сервис-воркера. Если значение false или параметр не указан, виджет регистрирует сервис-воркер при инициализации. Если значение true, сервис-воркер нужно зарегистрировать до инициализации виджета.
customWorkerScopestringСкоуп сервис-воркера при isWorkerManualRegistration=true. По умолчанию используется глобальный скоуп /.
vapidKeystringПубличный VAPID-ключ, сгенерированный на платформе edna. Передаётся в init().
logEnabledbooleanВключает расширенное логирование. По умолчанию true в тестовых сборках и false в промышленной среде. Размещается в localStorage.
optionsobjectНеобязательные параметры инициализации виджета. Передаются вторым аргументом init().
isSentryOnbooleanФлаг отправки событий аналитики.
overrideBaseUrlstringПереопределяет базовый адрес веб-виджета.
resubscribeIntervalnumberПериодичность обновления подписки виджета в секундах. Значение по умолчанию — 2 недели.