YMPYandexMetricaPush class

downloadAttachmentsForNotificationRequest:

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

Uploads attached files in push notifications. The method is available for iOS 10.0 and higher.

handleApplicationDidFinishLaunching(withOptions:)

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

Handles push notification openings from the method application (_: didFinishLaunchingWithOptions:). Method should be invoked after AppMetrica SDK initialization.

handleDidReceive(_:)

class func handleDidReceive(_ request: UNNotificationRequest?)

Handles push notifications receiving from Notification Service Extension.

You should call the method in the implementation of didReceive (_: withContentHandler:).

handleRemoteNotification(_:)

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

Handles push notification openings from the method application(_:didReceiveRemoteNotification:fetchCompletionHandler:) Method should be invoked after AppMetrica SDK initialization.

handleSceneWillConnectToSession(with: connectionOptions)

class func handleSceneWillConnectToSession(with: connectionOptions)

Handles push notification openings from the method scene(_:willConnectTo:options:). Method should be invoked after AppMetrica SDK initialization.

isNotificationRelated(toSDK:)

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

Returns YES if a push notification is related to AppMetrica.

Returns:

• YES — If the push notification refers to AppMetrica.
• NO — If the push notification is not related to AppMetrica.

setDeviceTokenFrom(_:)

class func setDeviceTokenFrom(_ data: Data?)

Registers the device token for an application with a production environment. Method should be invoked after AppMetrica SDK initialization.

setDeviceTokenFrom(_:pushEnvironment:)

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

Registers the device token of the application with the specified environment. Method should be invoked after AppMetrica SDK initialization.

setExtensionAppGroup(_:)

class func setExtensionAppGroup(_ appGroup: String?)

Registers the App Groups shared group for the app and Notification Service Extension.

Registration is necessary for tracking the delivery of push notifications. For more information, see Configuring statistics collection for push notifications.

userData(forNotification:)

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

Returns:

An arbitrary data string.

userNotificationCenterDelegate()

class func userNotificationCenterDelegate() -> YMPUserNotificationCenterDelegate?

Returns a delegate YMPUserNotificationCenterDelegate, which handles foreground push notifications on iOS 10 and higher.

To handle foreground push notifications, add this code to the application(_:didFinishLaunchingWithOptions:) method:

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

To manually handle push notifications, use userNotificationCenterHandler().

Returns:

A delegate that implements the YMPUserNotificationCenterDelegate protocol.

userNotificationCenterHandler()

class func userNotificationCenterHandler() -> YMPUserNotificationCenterHandling?

Returns a delegate YMPUserNotificationCenterHandling, which allows you to manually handle foreground push notifications on iOS 10 and higher.

Use this delegate if you implement the UNUserNotificationCenterDelegate protocol with custom logic. In this case, you should implement all methods of the UNUserNotificationCenterDelegate delegate and call the corresponding methods in YMPUserNotificationCenterHandling.

For simplified push notification handling, use userNotificationCenterDelegate()

Returns:

A delegate that implements the YMPUserNotificationCenterHandling protocol.