Integrate your app with Kochava’s Push Notifications Service.

Overview

The following builds upon Apple’s remote notifications capability, as outlined here. You can use Kochava’s Push Notifications Service to send remote notifications to your apps, as well as track app uninstalls and other analytics.

Integration

The following assumes that you have already integrated the Kochava iOS or tvOS SDK. For more information see iOS/tvOS – SDK Integration.

1. Register the Remote Notifications Device Token.

Use class KVAPushNotificationsToken class func register(withData:), and pass the deviceToken data parameter provided by the operating system.

• Swift v5
• Objective-C v5
• Swift v4
• Objective-C v4
• Swift v3(legacy)

• Swift

  func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {     KVAPushNotificationsToken.register(withData: deviceToken) }

  1 2 3 4

  func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {     KVAPushNotificationsToken.register(withData: deviceToken) }

• Objective-C

  - (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {     [KVAPushNotificationsToken registerWithData:deviceToken]; }

  1 2 3 4

  - (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {     [KVAPushNotificationsToken registerWithData:deviceToken]; }

• Swift

  func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) { KVAPushNotificationsToken.add(withData: deviceToken) }

  1 2 3 4

  func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {     KVAPushNotificationsToken.add(withData: deviceToken) }

• Objective-C

  - (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken { [KVAPushNotificationsToken addWithData:deviceToken]; }

  1 2 3 4

  - (void)application:(UIApplication *)application didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken {     [KVAPushNotificationsToken addWithData:deviceToken]; }

• Swift

  func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) { KVATracker.shared.addRemoteNotificationsDeviceToken(deviceToken) }

  1 2 3 4

  func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {     KVATracker.shared.addRemoteNotificationsDeviceToken(deviceToken) }

 

2. Send Push Opened Events.

When your app is opened through a push notification, you may create and send an instance of class KochavaEvent to track that this occurred. The event type should be of type .pushOpened. The event payload should contain the response.notification.request.content.userInfo, so that the event can be attributed to a campaign. It is also recommended that you pass the response.actionIdentifier, so that you may track what action the user selected.

• Swift v4
• Objective-C v4
• Swift v3(legacy)
• Objective-C v3(legacy)

• Swift

  @available(iOS 10.0, tvOS 10.0, watchOS 3.0, *) func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {     // KVAEvent     // ⓘ Create and send for .pushOpened     let event = KVAEvent(type: .pushOpened)     event.payloadDictionary = response.notification.request.content.userInfo     event.actionString = response.actionIdentifier     event.send() }

  1 2 3 4 5 6 7 8 9 10

  @available(iOS 10.0, tvOS 10.0, watchOS 3.0, *) func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {     // KVAEvent     // ⓘ Create and send for .pushOpened     let event = KVAEvent(type: .pushOpened)     event.payloadDictionary = response.notification.request.content.userInfo     event.actionString = response.actionIdentifier     event.send() }

• Objective-C

  - (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)(void))completionHandler {     // KVAEvent     // ⓘ Create and send for .pushOpened     KVAEvent *event = [KVAEvent eventWithType:KVAEventType.pushOpened];     event.payloadDictionary = response.notification.request.content.userInfo;     event.actionString = response.actionIdentifier; [event send]; }

  1 2 3 4 5 6 7 8 9

  - (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)(void))completionHandler {     // KVAEvent     // ⓘ Create and send for .pushOpened     KVAEvent *event = [KVAEvent eventWithType:KVAEventType.pushOpened];     event.payloadDictionary = response.notification.request.content.userInfo;     event.actionString = response.actionIdentifier;     [event send]; }

• Swift

  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool { if #available(iOS 10.0, tvOS 10.0, watchOS 3.0, *) { UNUserNotificationCenter.current().delegate = self } return true }

  1 2 3 4 5 6 7 8 9

  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey: Any]?) -> Bool {     if #available(iOS 10.0, tvOS 10.0, watchOS 3.0, *)     {        UNUserNotificationCenter.current().delegate = self     }     return true }

  Swift

  @available(iOS 10.0, tvOS 10.0, watchOS 3.0, *) func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) { // KochavaEvent // ... create and send for .pushOpened if let event = KochavaEvent(eventTypeEnum: .pushOpened) { event.payloadDictionary = response.notification.request.content.userInfo event.actionString = response.actionIdentifier KVATracker.shared.send(event) } }

  1 2 3 4 5 6 7 8 9 10 11 12 13 14

  @available(iOS 10.0, tvOS 10.0, watchOS 3.0, *) func userNotificationCenter(_ center: UNUserNotificationCenter, didReceive response: UNNotificationResponse, withCompletionHandler completionHandler: @escaping () -> Void) {     // KochavaEvent     // ... create and send for .pushOpened     if let event = KochavaEvent(eventTypeEnum: .pushOpened)     {         event.payloadDictionary = response.notification.request.content.userInfo                      event.actionString = response.actionIdentifier                      KVATracker.shared.send(event)     } }

• Objective-C

  - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { if (@available(iOS 10.0, tvOS 10.0, watchOS 3.0, *)) { UNUserNotificationCenter.currentNotificationCenter.delegate = self; } return YES; }

  1 2 3 4 5 6 7 8 9

  - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {     if (@available(iOS 10.0, tvOS 10.0, watchOS 3.0, *))     {         UNUserNotificationCenter.currentNotificationCenter.delegate = self;     }              return YES; }

  Objective-C

  - (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)(void))completionHandler { // KochavaEvent // ... create and send for .pushOpened KochavaEvent *event = [KochavaEvent eventWithEventTypeEnum:KochavaEventTypeEnumPushOpened]; if (event != nil) { event.payloadDictionary = response.notification.request.content.userInfo; event.actionString = response.actionIdentifier; [KVATracker.shared sendEvent:event]; } }

  1 2 3 4 5 6 7 8 9 10 11 12 13

  - (void)userNotificationCenter:(UNUserNotificationCenter *)center didReceiveNotificationResponse:(UNNotificationResponse *)response withCompletionHandler:(void (^)(void))completionHandler {     // KochavaEvent     // ... create and send for .pushOpened     KochavaEvent *event = [KochavaEvent eventWithEventTypeEnum:KochavaEventTypeEnumPushOpened];          if (event != nil)     {         event.payloadDictionary = response.notification.request.content.userInfo;         event.actionString = response.actionIdentifier;         [KVATracker.shared sendEvent:event];     } }

 

3. Activate Push Notifications with Kochava.

Push Notifications must be activated on your Kochava dashboard. From there you may also configure push notification campaigns.

4. Optionally clear your application icon badge number. For more information, refer to our Engagement Overview documentation

On your Kochava dashboard you may indicate that you want the application icon badge number set when push notifications are sent. If you enable this option you should be prepared to clear your badge number when your application becomes active, or at some other appropriate time. For more information see instance property applicationIconBadgeNumber.