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

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

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

Библиотека EDNAPushNE предоставляет методы и свойства для обработки push-уведомлений в расширении Notification Service Extension, включая обработку данных уведомления, загрузку полного контента, передачу статусов на push-сервер и настройку параметров расширения.

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

didReceive​

Обрабатывает данные push-уведомления в библиотеке. Используется при базовом варианте интеграции библиотеки в расширение уведомлений.

Синтаксис​

didReceive(
_ request: UNNotificationRequest,
withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void
)

Параметры​

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

serviceExtensionTimeWillExpire​

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

Синтаксис​

serviceExtensionTimeWillExpire()

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

isProductionMode​

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

Синтаксис​

isProductionMode(for helper: EDNAPushNEHelper) -> Bool

Параметры​

  • helper — экземпляр EDNAPushNEHelper.

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

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

deviceAddress​

Возвращает регистрационный адрес приложения. Используется как альтернатива передаче регистрационных данных через AppGroup.

Синтаксис​

deviceAddress(for helper: EDNAPushNEHelper) -> String

Параметры​

  • helper — экземпляр EDNAPushNEHelper.

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

  • String — актуальное значение deviceAddress, полученное от библиотеки EDNAPushLite.

log​

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

Синтаксис​

log(withInfo info: String, for helper: EDNAPushNEHelper)

Параметры​

  • info — текст записи журнала;
  • helper — экземпляр EDNAPushNEHelper.

Пример обработки логов​

func log(text: String, logLevel: EDNALogLevel) {
let logPrefix: String
var needLog: Bool

switch logLevel {
case .info:
logPrefix = "INFO"
needLog = true
case .warning:
logPrefix = "WARN"
needLog = true
case .error:
logPrefix = "ERROR"
needLog = true
@unknown default:
fatalError()
}

if needLog {
Logger.log("[APP] pushLite.log -> \(logPrefix): \(text)")
}
}

config​

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

Синтаксис​

config(for helper: EDNAPushNEHelper) -> EDNAPushConfig

Параметры​

  • helper — экземпляр EDNAPushNEHelper.

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

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

Структура EDNAPushConfig​

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

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

СвойствоТипОписание
appGroupStringИдентификатор AppGroup, используемый для передачи регистрационных данных из приложения в расширение.
enableLoadFullContentBoolОпределяет, загружает ли библиотека полный контент push-сообщения при обработке данных уведомления методом processUserInfo.
enableLoggingBoolОпределяет, генерирует ли библиотека записи журнала.

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

processUserInfo​

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

подсказка

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

Результат обработки передаётся в структуре EDNAProcessResult.

Синтаксис​

processUserInfo(
userInfo: [AnyHashable: Any],
completionHandler: (EDNAProcessResult) -> Void,
errorHandler: (Error?) -> Void
)

Параметры​

  • userInfo — данные полученного push-уведомления;
  • completionHandler — обработчик, вызываемый при успешном завершении обработки и передающий результат EDNAProcessResult;
  • errorHandler — обработчик, вызываемый при возникновении ошибки.

Структура EDNAProcessResult​

ИмяТипОписание
messageIdStringИдентификатор сообщения.
complexMessageIdStringПолный идентификатор сообщения.
shortMessageStringТекст уведомления.
isOnlyPushBoolОпределяет доступность полного контента сообщения:
- true — полный контент недоступен;
- false — полный контент доступен.
isPushReceivedBoolПризнак успешной передачи информации о получении push-уведомления на push-сервер.
pushReceivedErrorErrorОшибка, возникшая при передаче информации о получении push-уведомления.
isContentLoadedBoolПризнак успешной загрузки полного контента сообщения.
fullMessageStringПолный контент сообщения, полученный от push-сервера.
contentLoadingErrorErrorОшибка, возникшая при загрузке полного контента сообщения.
isContentReceivedBoolПризнак успешной передачи информации о получении полного контента на push-сервер.
contentReceivingErrorErrorОшибка, возникшая при передаче информации о получении полного контента.
logoFullAttachment—Логотип из fullMessage в формате для UNNotificationRequest -> content -> attachments. Заполняется только при useFullContentForAutodraw = true.
pushNotificationText—Текст из fullMessage для UNNotificationRequest -> content -> body. Заполняется только при useFullContentForAutodraw = true.
pushAttributes—Атрибуты из fullMessage. Заполняется только при useFullContentForAutodraw = true.

confirmPushDelivery Deprecated​

Передаёт на push-сервер информацию о получении push-уведомления.

Синтаксис​

confirmPushDelivery(
userInfo: [AnyHashable: Any],
completionHandler: () -> Void,
errorHandler: (Error?) -> Void
)

Параметры​

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

Настройки файла Info.plist​

СвойствоТипОписание
edna_app_groupStringИдентификатор AppGroup, используемый для передачи регистрационных данных из приложения в расширение.
edna_use_test_modeBoolОпределяет окружение push-сервера, используемое библиотекой:
- true — тестовое окружение;
- false — продуктивное окружение.