Installation and initialization

Before using the AppMetrica Push SDK 1.3.0, you need to enable and initialize the AppMetrica SDK version 3.4.1 or higher.

Step 1. Enable the libraryStep 1. Enable the library

The library can work with the following dependency managers:

binary "https://raw.githubusercontent.com/yandexmobile/metrica-push-sdk-ios/master/YandexMobileMetricaPush.json" ~> 1.3.0

Step 2. Register your app in the Apple Push Notification Service (APNs)Step 2. Register your app in the Apple Push Notification Service (APNs)

Registration prepares the app to work with push notifications. To send notifications to iOS devices, make the following changes to the app's code:

let center = UNUserNotificationCenter.current()
center.requestAuthorization(options:\[.badge, .alert, .sound\]) { (granted, error) in
  // Enable or disable features based on authorization.
}
application.registerForRemoteNotifications()

func application(_ application: UIApplication, didFinishLaunchingWithOptions
                 launchOptions: [UIApplicationLaunchOptionsKey :Any]? = nil) -> Bool

UNAuthorizationOptions options =
  UNAuthorizationOptionAlert |
    UNAuthorizationOptionBadge |
    UNAuthorizationOptionSound;
UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter];
[center requestAuthorizationWithOptions:options completionHandler:^(BOOL granted, NSError *error) {
  // Enable or disable features based on authorization.
}];
[application registerForRemoteNotifications];

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions

Step 3. Register a device token for your appStep 3. Register a device token for your app

To send push notifications using AppMetrica, your app's device token is required. To register it:

func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data)
{
    // If the AppMetrica SDK library was not initialized before this step,
    // calling the method causes the app to crash.
    YMPYandexMetricaPush.setDeviceTokenFrom(deviceToken)
}

- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
{
    // If the AppMetrica SDK library was not initialized before this step,
    // calling the method causes the app to crash.
    [YMPYandexMetricaPush setDeviceTokenFromData:deviceToken];
}

To register the device token and send the APN environments, add the following code:

func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data)
{
    // If the AppMetrica SDK library was not initialized before this step,
    // calling the method causes the app to crash.
    #if DEBUG
        let pushEnvironment = YMPYandexMetricaPushEnvironment.development
    #else
        let pushEnvironment = YMPYandexMetricaPushEnvironment.production
    #endif
    YMPYandexMetricaPush.setDeviceTokenFrom(deviceToken, pushEnvironment: pushEnvironment)
}

- (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken
{
    // If the AppMetrica SDK library was not initialized before this step,
    // calling the method causes the app to crash.
    #ifdef DEBUG
        YMPYandexMetricaPushEnvironment pushEnvironment = YMPYandexMetricaPushEnvironmentDevelopment;
    #else
        YMPYandexMetricaPushEnvironment pushEnvironment = YMPYandexMetricaPushEnvironmentProduction;
    #endif
    [YMPYandexMetricaPush setDeviceTokenFromData:deviceToken pushEnvironment:pushEnvironment];
}

Step 4. Configure handling the opening of push notificationsStep 4. Configure handling the opening of push notifications

Configure handling the opening of push notifications:

1. Use the delegate YMPUserNotificationCenterDelegate. It handles the receipt of push notifications automatically when they're opened.

   Make the following changes to the code:

   Swift

   Objective-С

   import UserNotifications
   
   // In the "func application(_ application: UIApplication, didFinishLaunchingWithOptions
   //                          launchOptions: [UIApplicationLaunchOptionsKey : Any]? = nil) -> Bool" method:
   let delegate = YMPYandexMetricaPush.userNotificationCenterDelegate()
   UNUserNotificationCenter.current().delegate = delegate
   

   #import <UserNotifications/UserNotifications.h>
   
   // In the   "- (BOOL)application:(UIApplication *)application
   // didFinishLaunchingWithOptions:(NSDictionary *)launchOptions" method:
   [UNUserNotificationCenter currentNotificationCenter].delegate =
           [YMPYandexMetricaPush userNotificationCenterDelegate];
   

   To track push notification openings and other actions with them, create your own delegate named UNUserNotificationCenterDelegate and add it to nextDelegate:

   Swift

   Objective-С

   YMPYandexMetricaPush.userNotificationCenterDelegate().nextDelegate = yourDelegate
   

   [YMPYandexMetricaPush userNotificationCenterDelegate].nextDelegate = yourDelegate;
   

   After that, you can use the appropriate methods of your delegate.

2. If you also use UISceneDelegate, add the following code to the scene(_:willConnectTo:options:) method:

   Swift

   Objective-С

   func scene(_ scene: UIScene, willConnectTo
              session: UISceneSession, options
              connectionOptions: UIScene.ConnectionOptions) {
        YMPYandexMetricaPush.handleSceneWillConnectToSession(with: connectionOptions)
   }
   

   - (void)scene:(UIScene *)scene willConnectToSession:(UISceneSession *)session
         options:(UISceneConnectionOptions *)connectionOptions
   {
       [YMPYandexMetricaPush handleSceneWillConnectToSessionWithOptions:connectionOptions];
   }
   

Step 5. (Optional) Enable push tokens updateStep 5. (Optional) Enable push tokens update

The APNS service can withdraw the push token of the device, for example, if the user did not launch the application for a long time. AppMetrica stores push tokens on the server and can not send a push notification to a device with an obsolete token.

To automatically collect current push token go to the application settings in the AppMetrica interface and enable the Update tokens with a Silent Push notification option in the Push Notifications tab.

Step 6. (Optional) Configure uploading attached filesStep 6. (Optional) Configure uploading attached files

You can configure uploading attached files in push notifications:

1. Configure uploading attached files in push notifications by calling the downloadAttachmentsForNotificationRequest method in the Push SDK. See an example of integration in the article Uploading attached files.
2. Add attachments (the attachments parameter) using the Sending push messages operation in the Push API.

Sending additional informationSending additional information

You can send additional information with the push notification if necessary. This data is specified in the AppMetrica web interface when configuring the push campaign. To get this information, use the following method:

let userData = YMPYandexMetricaPush.userData(forNotification: userInfo)

NSString *userData = [YMPYandexMetricaPush userDataForNotification:userInfo];

where userInfo contains information about the push notification.

Defining the recipient of a notificationDefining the recipient of a notification

AppMetrica allows you to detect own push notifications, if several Push SDKs were built into the application.

To detect, if the AppMetrica is the recipient of a notification, use the following method:

let isRelatedToAppMetricaSDK = YMPYandexMetricaPush.isNotificationRelated(toSDK: userInfo)

BOOL isRelatedToAppMetricaSDK = [YMPYandexMetricaPush isNotificationRelatedToSDK:userInfo];

See alsoSee also

• Example of library integration
• Configuring an iOS application to send push notifications

If you didn't find the answer you were looking for, you can use the feedback form to submit your question. Please describe the problem in as much detail as possible. Attach a screenshot if possible.