Класс YMPYandexMetricaPush

Основной класс для обработки Push-уведомлений.

Методы экземпляраМетоды экземпляра

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

downloadAttachmentsForNotificationRequest:downloadAttachmentsForNotificationRequest:

class func downloadAttachments(request: UNNotificationRequest, callback: YMPAttachmentsDownloadCallback)

Загружает прикрепленные файлы в push-уведомлениях. Метод доступен для iOS 10.0 и выше.

Параметры:

public typealias YMPAttachmentsDownloadCallback = ([UNNotificationAttachment]?, Error?) -> Void`

handleApplicationDidFinishLaunching(withOptions:)handleApplicationDidFinishLaunching(withOptions:)

class func handleApplicationDidFinishLaunching(withOptions launchOptions: [AnyHashable : Any]?)

Обрабатывает открытие push-уведомления из метода application(_:didFinishLaunchingWithOptions:). Метод должен быть вызван после инициализации AppMetrica SDK.

Параметры:

handleDidReceive(_:)handleDidReceive(_:)

class func handleDidReceive(_ request: UNNotificationRequest?)

Обрабатывает получение push-уведомления из расширения Notification Service Extension.

Метод должен быть вызван в реализации метода didReceive(_:withContentHandler:).

Параметры:

handleRemoteNotification(_:)handleRemoteNotification(_:)

class func handleRemoteNotification(_ userInfo: [AnyHashable : Any]?)

Обрабатывает открытие push-уведомления из метода application(_:didReceiveRemoteNotification:fetchCompletionHandler:). Метод должен быть вызван после инициализации AppMetrica SDK.

Параметры:

handleSceneWillConnectToSession(with: connectionOptions)handleSceneWillConnectToSession(with: connectionOptions)

class func handleSceneWillConnectToSession(with: connectionOptions)

Обрабатывает открытие push-уведомления из метода scene(_:willConnectTo:options:). Метод должен быть вызван после инициализации AppMetrica SDK.

Параметры:

isNotificationRelated(toSDK:)isNotificationRelated(toSDK:)

class func isNotificationRelated(toSDK userInfo: [AnyHashable : Any]?) -> Bool

Возвращает YES, если push-уведомление относится к AppMetrica.

Параметры:

Возвращает:

• YES — если push-уведомление относится к AppMetrica.
• NO — если push-уведомление не относится к AppMetrica.

setDeviceTokenFrom(_:)setDeviceTokenFrom(_:)

class func setDeviceTokenFrom(_ data: Data?)

Регистрирует device token приложения с production-окружением. Метод должен быть вызван после инициализации AppMetrica SDK.

Параметры:

setDeviceTokenFrom(_:pushEnvironment:)setDeviceTokenFrom(_:pushEnvironment:)

class func setDeviceTokenFrom(_ data: Data?, pushEnvironment: YMPYandexMetricaPushEnvironment)

Регистрирует device token приложения с указанным окружением. Метод должен быть вызван после инициализации AppMetrica SDK.

Параметры:

setExtensionAppGroup(_:)setExtensionAppGroup(_:)

class func setExtensionAppGroup(_ appGroup: String?)

Регистрирует общую группу App Groups приложения и Notification Service Extension.

Регистрация необходима для отслеживания доставки push-уведомлений. Подробнее в разделе Настройка сбора статистики push-уведомлений.

Параметры:

userData(forNotification:)userData(forNotification:)

class func userData(forNotification userInfo: [AnyHashable : Any]?) -> String?

Возвращает произвольную строку данных, которая передается в push-уведомлении:

• В поле Дополнительные данные при отправке из интерфейса AppMetrica.
• В поле data при отправке с помощью Push API.

Параметры:

Возвращает:

Произвольная строка данных.

userNotificationCenterDelegate()userNotificationCenterDelegate()

class func userNotificationCenterDelegate() -> YMPUserNotificationCenterDelegate?

Возвращает делегат YMPUserNotificationCenterDelegate, который обрабатывает foreground push-уведомления на iOS 10 и выше.

Для обработки foreground push-уведомлений, добавьте этот код в методе application(_:didFinishLaunchingWithOptions:):

let delegate = YMPYandexMetricaPush.userNotificationCenterDelegate()
UNUserNotificationCenter.current().delegate = delegate

Для ручной обработки push-уведомлений используйте userNotificationCenterHandler().

Возвращает:

Делегат, который реализует протокол YMPUserNotificationCenterDelegate.

userNotificationCenterHandler()userNotificationCenterHandler()

class func userNotificationCenterHandler() -> YMPUserNotificationCenterHandling?

Возвращает делегат YMPUserNotificationCenterHandling, который позволяет вручную обрабатывать foreground push-уведомления на iOS 10 и выше.

Используйте этот делегат, если вы реализуете протокол UNUserNotificationCenterDelegate с собственной логикой. При этом необходимо реализовать каждый метод из делегата UNUserNotificationCenterDelegate и вызывать соответствующие методы в YMPUserNotificationCenterHandling.

Для упрощенной обработки push-уведомлений используйте userNotificationCenterDelegate()

Возвращает:

Делегат, который реализует протокол YMPUserNotificationCenterHandling.