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

Методы библиотеки EDNAPushLite

Обновлено: 2 сентября 2026

Библиотека EDNAPushLite предоставляет методы для обработки системных событий, связанных с регистрацией устройства и получением push-уведомлений.

Методы протокола EDNAPushLiteAppDelegateProxy​

Методы протокола EDNAPushLiteAppDelegateProxy используются для передачи системных событий из AppDelegate в библиотеку EDNAPushLite.

didRegisterForRemoteNotifications​

Передаёт в библиотеку событие успешной регистрации приложения для получения push-уведомлений.

Синтаксис​

EDNAPushLite.appDelegate.didRegisterForRemoteNotifications(
withDeviceToken deviceToken: Data
)

Параметр​

  • deviceToken — токен устройства, полученный от операционной системы.

EDNAPushLite.appDelegate.didFailToRegisterForRemoteNotifications​

Передаёт в библиотеку событие ошибки при регистрации приложения для получения push-уведомлений.

Синтаксис​

EDNAPushLite.appDelegate.didFailToRegisterForRemoteNotifications(
withError error: Error
)

Параметр​

  • error — ошибка, полученная при регистрации приложения.

EDNAPushLite.appDelegate.didReceiveRemoteNotification​

Передаёт в библиотеку событие получения push-уведомления.

Синтаксис​

EDNAPushLite.appDelegate.didReceiveRemoteNotification(
_ userInfo: [AnyHashable: Any]?,
fetchCompletionHandler: @escaping ((UIBackgroundFetchResult) -> ())
)

Параметры​

  • userInfo — данные push-уведомления, полученные от операционной системы;
  • fetchCompletionHandler — обработчик, вызываемый после завершения обработки push-уведомления библиотекой.

Методы протокола EDNAPushLiteDelegate​

Протокол EDNAPushLiteDelegate содержит методы обратного вызова, с помощью которых библиотека EDNAPushLite передаёт приложению информацию об инициализации библиотеки, состоянии устройства, полученных push-уведомлениях, действиях пользователя и параметрах конфигурации.

isProduction​

Определяет окружение push-сервера, используемое библиотекой.

Синтаксис​

isProduction(pushApi: EDNAPushLite) -> Bool

Параметры​

  • pushApi — экземпляр EDNAPushLite.

Возвращаемое значение​

  • true — библиотека работает с продуктивным сервером;
  • false — библиотека работает с тестовым сервером.

didStarted​

Вызывается после успешной инициализации библиотеки EDNAPushLite.

Синтаксис​

didStarted(pushApi: EDNAPushLite, configResult: EDNAPushLiteConfigResult)

Параметры​

  • pushApi — экземпляр EDNAPushLite;
  • configResult — результат конфигурации EDNAPushLite, содержащий параметры инициализации, в том числе значение deviceUid.

onActualDeviceAddress​

Передаёт актуальное значение deviceAddress устройства. Вызывается при каждой инициализации библиотеки, а также при изменении значения deviceAddress.

Синтаксис​

onActualDeviceAddress(
pushApi: EDNAPushLite,
deviceAddress: String,
isChanged: Bool
)

Параметры​

  • pushApi — экземпляр EDNAPushLite;
  • deviceAddress — текущее значение адреса устройства;
  • isChanged — признак изменения deviceAddress с момента предыдущего вызова метода.

getDeviceInfo​

Возвращает параметры устройства, необходимые для его регистрации на push-сервере. Рекомендуется вызывать после метода onActualDeviceAddress.

Синтаксис​

getDeviceInfo()

Возвращаемое значение​

Метод возвращает параметры устройства.

ИмяТипЗначение
deviceAddressStringУникальный адрес мобильного приложения, установленного на устройстве.
deviceUIDStringУникальный идентификатор мобильного приложения, установленного на устройстве.
deviceNameStringНазвание устройства.
systemNameStringНазвание мобильной операционной системы.
appPackageStringУникальный идентификатор приложения в App Store.
localeStringЛокаль интерфейса устройства.
timezoneStringЧасовой пояс, установленный на устройстве.
notificationAlertAllowedBoolПризнак разрешения на отображение push-уведомлений.
notificationDelayedViewEnabledBoolПризнак включения приложения в сводку уведомлений.
timeSensitiveNotificationAllowedBoolПризнак разрешения на отображение уведомлений с пометкой time-sensitive.

log​

Передаёт приложению записи журнала библиотеки для сохранения или обработки.

Синтаксис​

log(text: String, logLevel: EDNALogLevel)

Параметры​

  • text — текст записи журнала;
  • logLevel — уровень записи журнала EDNALogLevel.

onPushReceived​

Вызывается при получении push-уведомления и передаёт его данные приложению для обработки.

Синтаксис​

onPushReceived(
pushApi: EDNAPushLite,
pushData: EDNAPushData
)

Параметры​

  • pushApi — экземпляр EDNAPushLite;
  • pushData — данные полученного push-уведомления EDNAPushData.

Структура EDNAPushData​

ИмяТипЗначение
userInfoDictionaryДанные полученного уведомления. Определены только для одного сообщения из списка.
messageIdStringИдентификатор сообщения.
complexMessageIdStringПолный идентификатор сообщения.
shortMessageStringТекст уведомления.
hasFullContentBoolПризнак наличия полного содержимого уведомления.
chlSentAtDateВремя отправки уведомления.

onPushMessagesReceived​

Вызывается при получении полного содержимого push-сообщений и передаёт массив сообщений приложению для обработки.

Синтаксис​

onPushMessagesReceived(
pushApi: EDNAPushLite,
messages: [EDNAPushMessage]
)

Параметры​

  • pushApi — экземпляр EDNAPushLite;
  • messages — массив полученных сообщений EDNAPushMessage.

Структура EDNAPushMessage​

ИмяТипЗначение
userInfoDictionaryДанные полученного уведомления. Определены только для одного сообщения из списка.
shortMessageStringТекст уведомления.
fullMessageStringПолное содержимое сообщения, полученное от push-сервера.
messageIdStringИдентификатор сообщения.
complexMessageIdStringПолный идентификатор сообщения.
sentAtMillisInt64Время отправки уведомления в миллисекундах.
sentAtDateВремя отправки уведомления.
syncUserInfoDictionaryДанные для синхронизации с сервером.

onPushAction​

Вызывается при нажатии на push-уведомление или кнопку действия в расширенном push-уведомлении.

Синтаксис​

подсказка

Метод поддерживает два варианта сигнатуры.

onPushAction(actionId: String)
onPushAction(
actionId: String,
userInfo: [AnyHashable: Any]
)

Параметры​

  • actionId — идентификатор выполненного действия;
  • userInfo — исходные данные push-уведомления.
подсказка

Во втором варианте метода userInfo содержит исходное сообщение.

getCustomDeviceUid​

Возвращает пользовательское значение deviceUid вместо автоматически сгенерированного библиотекой.

Синтаксис​

getCustomDeviceUid(pushApi: EDNAPushLite) -> String

Параметры​

  • pushApi — экземпляр EDNAPushLite.

Возвращаемое значение​

  • String — пользовательское значение deviceUid.

getCustomUrls​

Передаёт библиотеке конфигурацию пользовательского набора push-серверов.

Синтаксис​

getCustomUrls(pushApi: EDNAPushLite) -> EDNAPushLiteUrls

Параметры​

  • pushApi — экземпляр EDNAPushLite.

Возвращаемое значение​

  • EDNAPushLiteUrls — конфигурация push-серверов.

Структура EDNAPushLiteUrls​

ИмяТипЗначение
primaryUrlCodeStringИдентификатор основного сервера, используемого по умолчанию. Значение должно соответствовать идентификатору из urls.
urls[String: String]Список пар «идентификатор сервера — адрес сервера».

presentationOptions​

Определяет параметры отображения push-уведомления.

Синтаксис​

presentationOptions(
for notification: UNNotification
) -> UNNotificationPresentationOptions

Параметры​

  • notification — полученное push-уведомление UNNotification.

Возвращаемое значение​

  • UNNotificationPresentationOptions — набор параметров отображения уведомления. Например:
[.alert, .badge, .sound]

Свойства и методы класса EDNAPushLite​

Класс EDNAPushLite предоставляет свойства для настройки библиотеки и методы для управления её работой, регистрации приложения на получение push-уведомлений и обработки статуса сообщений.

Свойства класса EDNAPushLite​

СвойствоТипОписание
appGroupStringИдентификатор AppGroup, используемый для обмена данными между приложением и его расширением.
autoRegisterForNotificationBoolОпределяет, кто выполняет регистрацию приложения для получения push-уведомлений:
- true — библиотека;
- false — приложение.
logEnableBoolОпределяет, генерирует ли библиотека записи журнала и вызывает ли метод log.
showNetworkActivityBoolОпределяет, отображается ли индикатор сетевой активности в строке состояния операционной системы.
appPackagePostfixStringПостфикс, используемый при регистрации приложения на push-сервере.

Методы класса EDNAPushLite​

resetNewMessageCounter​

Сбрасывает на push-сервере счётчик новых сообщений. При успешном сбросе счётчика также обнуляет значение badge на иконке приложения.

Синтаксис​

resetNewMessageCounter(
withCompetionHandler competionHandler: () -> (),
errorHandler: (String) -> ()
)

Параметры​

  • competionHandler — обработчик, вызываемый при успешном выполнении операции;
  • errorHandler — обработчик, вызываемый при возникновении ошибки.

start​

Инициализирует библиотеку EDNAPushLite и запускает её работу.

warning

Метод является обязательным: без его вызова библиотека не будет работать. Все свойства библиотеки, доступные для изменения, должны быть настроены до вызова start().

Синтаксис​

start()

markAsRead​

Передаёт на push-сервер информацию о прочтении сообщений с указанными complexMessageId.

Синтаксис​

markAsRead(
complexMessageIds: [String],
didFinished: (() -> Void)?
)

Параметры​

  • complexMessageIds — список идентификаторов сообщений, которые необходимо отметить как прочитанные;
  • didFinished — обработчик, вызываемый после передачи статуса прочтения на push-сервер.

registerForRemoteNotification​

Выполняет регистрацию приложения для получения push-уведомлений.

к сведению

Метод может использоваться для отложенной первой регистрации приложения. Его необходимо вызывать после инициализации библиотеки и при каждом запуске приложения.

Для использования метода необходимо установить свойство:

autoRegisterForNotification = false

Метод также устанавливает делегат UNUserNotificationCenter.current().delegate в класс библиотеки.

Если приложение использует собственный обработчик UNUserNotificationCenterDelegate, после вызова registerForRemoteNotification() необходимо повторно установить собственный класс в качестве делегата UNUserNotificationCenter.current().delegate.

Синтаксис​

registerForRemoteNotification()

Методы класса EDNAPushLite.notificationCenter​

Класс EDNAPushLite.notificationCenter предоставляет методы для передачи библиотеке системных событий UNUserNotificationCenterDelegate.

Если приложение самостоятельно реализует соответствующие методы UNUserNotificationCenterDelegate, необходимо вызвать в них методы EDNAPushLite.notificationCenter.

userNotificationCenter(_:willPresent:withCompletionHandler:)​

Передаёт библиотеке событие получения push-уведомления, когда приложение находится на переднем плане.

Метод необходимо вызывать из соответствующего метода UNUserNotificationCenterDelegate, если он реализован приложением.

Синтаксис​

userNotificationCenter(
_ center: UNUserNotificationCenter,
willPresent notification: UNNotification,
withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void
)

Параметры​

  • center — центр уведомлений UNUserNotificationCenter, переданный операционной системой;
  • notification — полученное push-уведомление UNNotification;
  • completionHandler — обработчик, вызываемый после завершения обработки уведомления.

userNotificationCenter(_:didReceive:withCompletionHandler:)​

Передаёт библиотеке событие взаимодействия пользователя с push-уведомлением.

Метод необходимо вызывать из соответствующего метода UNUserNotificationCenterDelegate, если он реализован приложением.

Синтаксис​

userNotificationCenter(
_ center: UNUserNotificationCenter,
didReceive response: UNNotificationResponse,
withCompletionHandler completionHandler: @escaping () -> Void
)

Параметры​

  • center — центр уведомлений UNUserNotificationCenter, переданный операционной системой;
  • response — данные о взаимодействии пользователя с push-уведомлением UNNotificationResponse;
  • completionHandler — обработчик, вызываемый после завершения обработки события.

Пример​

Если приложение реализует методы UNUserNotificationCenterDelegate, вызовите соответствующий метод EDNAPushLite.notificationCenter внутри реализации делегата:

func userNotificationCenter(
_ center: UNUserNotificationCenter,
didReceive response: UNNotificationResponse,
withCompletionHandler completionHandler: @escaping () -> Void
) {
pushApi.notificationCenter.userNotificationCenter(
center,
didReceive: response,
withCompletionHandler: completionHandler
)
// ...
}

func userNotificationCenter(
_ center: UNUserNotificationCenter,
willPresent notification: UNNotification,
withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void
) {
pushApi.notificationCenter.userNotificationCenter(
center,
willPresent: notification,
withCompletionHandler: completionHandler
)
// ...
}