PushIOManager for iOS

• Integration Guide

Release Notes

Upgrading PushIO SDK 6.29.2 to 6.32.0

• Supported iOS versions: PushIO SDK 6.32.0 and later will support iOS 8.0 and later.
• Supported XCode versions: PushIO SDK 6.32.0 and later is supported by XCode 8.3.2 onwards.

[1.] Add the SQLite framework to your application target:

6.32.0 uses sqlite to store the events (that is, register, engagement, unregister) and sync later. Your mobile application needs to add the sqlite3.0.tbd framework in your application target.

[2.] Add the UserNotifications framework to your application target:

6.32.0 works with the UserNotifications framework APIs. Your mobile application needs to add the UserNotifications framework.

[3.] Enable the Push Notifications capability:

Your mobile application needs to add the Push Notifications capability, which you can do from the Capabilities tab of your application settings.

Ensure that when you enable Push Notifications:

• Add the Push Notifications feature to your app id.
• Add the Push Notifications entitlement to your entitlements file

Code Changes

For PushIO SDK 6.32.0, make the following changes to your mobile application code:

[1.] Add Debug vs Release configuration in AppDelegate.m:

Mobile apps now control whether configuration is loaded from either pushio_config_debug.json or pushio_config.json.
Applications must set the configType to let the SDK read the suggested configuration file:

    #ifdef DEBUG
        [PushIOManager sharedInstance].configType = PIOConfigTypeDebug; //load pushio_config_debug.json
    #else
        [PushIOManager sharedInstance].configType = PIOConfigTypeRelease; //load pushio_config.json
    #endif

IMPORTANT: If your mobile app does not set the configType value, the app will not select a configuration file (pushio_config_debug.json or pushio_config.json). Without the configuration file, your app will be unable to communicate with the server, and critical functions will fail (register, fetch messages, track engagements, and the like).

[2.] Enable logging in AppDelegate.m:

With 6.32.0, setDebugLevel is discontinued. To enable logging, use the enableLogging and setLogLevel methods. Use disableLogging to disable logging.

    #ifdef DEBUG
        [[PushIOManager sharedInstance] enableLogging:YES];
        [[PushIOManager sharedInstance] setLogLevel:PIOLogLevelInfo]; //PIOLogLevelWarn or PIOLogLevelError
    #else
        [[PushIOManager sharedInstance] disableLogging];
    #endif

[3.] Implement UserNotifications framework support: Implement the UNUserNotificationCenterDelegate method in your AppDelegate.h and AppDelegate.m files, as shown below:

    //In AppDelegate.h
    #import <UserNotifications/UserNotifications.h>
    @interface AppDelegate : UIResponder <UIApplicationDelegate,UNUserNotificationCenterDelegate>
    @end

In AppDelegate.m, set the userNotificationCenter delegate, preferably in didFinishLaunchingWithOptions:

    [UNUserNotificationCenter currentNotificationCenter].delegate= self;

Implement userNotificationCenter delegate methods in Appdelegate.m:

    -(void) userNotificationCenter:(UNUserNotificationCenter *)center
        didReceiveNotificationResponse:(UNNotificationResponse *)response
                 withCompletionHandler:(void(^)())completionHandler{
        [[PushIOManager sharedInstance] userNotificationCenter:center didReceiveNotificationResponse:response withCompletionHandler:completionHandler];
    }

    -(void) userNotificationCenter:(UNUserNotificationCenter *)center
               willPresentNotification:(UNNotification *)notification
                 withCompletionHandler:(void (^)(UNNotificationPresentationOptions options))completionHandler{
        [[PushIOManager sharedInstance] userNotificationCenter:center willPresentNotification:notification withCompletionHandler:completionHandler];
    }

New Registration methods

[1.] Configure:

First application need to configure with SDK as following:

    NSError *error = nil;
    [[PushIOManager sharedInstance] configureWithAPIKey:API_KEY accountToken:ACCOUNT_TOKEN error:&error];
    if(nil == error){
        NSLog(@"SDK Configured Successfully");
    }else{
        NSLog(@"Unable to configure SDK, reason: %@", error.description);
    }

[2.] Register:

Once configured successfully, application can register with SDK as following:

[[PushIOManager sharedInstance] registerForAllRemoteNotificationTypes:^(NSError *error, NSString *deviceToken) {
        if (nil == error) {
            NSError *regTrackError = nil;
            [[PushIOManager sharedInstance] registerApp:&regTrackError completionHandler:^(NSError *regAppError, NSString *response) {
                if (nil == regAppError) {
                    NSLog(@"Application registered successfully!");
                }else{
                    NSLog(@"Unable to register application, reason: %@", regAppError.description);
                }
            }];
            if (nil == regTrackError) {
                NSLog(@"Registration locally stored successfully.");
            }else{
                NSLog(@"Unable to store registration, reason: %@", regTrackError.description);
            }
        }
    }];

Media Attachment

To integrate media notification follow the guide Stand alone or Integrated as applicable. In addition to that there are few extra steps needed to avoid specific errors:

• Don't add PIOMediaAttachmentExtension.framework into app target.
  • PIOMediaAttachmentExtension.framework should be added only in notification service extension target and not the application's target. Otherwise there will be installation issue in iOS version lower than iOS 10.
• Don't add PIOMediaAttachmentExtension.framework into embedded binaries.
  • PIOMediaAttachmentExtension.framework shouldn't be added as embedded binary. Otherwise there will be compile time error as: 'bundle format unrecognized, invalid, or unsuitable'

Other Resources

• [Downloads + Documenation] (http://docs.push.io)
• [Sign In / Sign Up] (https://manage.push.io)

Contact

• Support: [My Oracle Support] (http://support.oracle.com)

Copyright © 2016, Oracle Corporation and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.