Enabling SmartAlerts™ Notifications¶

Introduction¶

In v1.3 of Socialize we introduced push notifications. This provides your app with a simple and effective way to bring users back into the “viral loop” of the app.

Step 1: Setup SmartAlerts™ on the App Dashboard¶

for Push Notifications to work they must be enabled on a compatible plan at http://getsocialize.com/apps

Select your app and click “SmartAlerts Settings”

Then turn on enabled:

Step 2: Configuring Your Apple App ID¶

Find your App ID in the Apple’s developer portal here: https://developer.apple.com/ios/manage/bundles/index.action> . Then click ‘Configure’ on the right-hand side.

Make sure “Enable for Apple Push Notification service” is checked.

Step 3: Keys/Certificates for your App ID for APNS¶

• Click the ‘configure’ button for your desired certificate (‘Production Push SSL Certificate’ or ‘Development Push SSL Certificate’) on the right hand side. Follow the directions given to you by Apple very carefully.

• Open the certificate after completing the steps and downloading the certificate(.cer) by double clicking the file. This should result in the ‘Keychain Access’ application opening.
• Re-create your distribution provisioning profile, download and re-install the profile.

Step 4: Exporting your .p12 (key/certificate pair) from the Keychain Access tool.¶

Double-clicking the certificate(.cer) should automatically open the ‘Keychain Access’ tool.

• Find the ‘My Certificates’ category on the left hand side of the ‘Keychain Access’ tool.
• Right-click on the ‘Apple Production iOS Push Services’ and export the key/certificate pair in the p12 (Personal Information Exchange) format.
• Save this file without a password to your desktop.

Step 5: Uploading your .p12 to the Socialize Developer Portal¶

• Go to your SmartAlert’s setup dashboard and upload the p12 from the previous step. You can find your application dashboard here: http://www.getsocialize.com/apps

If you’ve added a password to your p12 make sure to put that in.

Step 6: Configuring Notifications in Your App¶

To configure your app you’ll need to register for notifications, handle the notification response and define an entity loader so we display users your content.

#pragma mark
- (BOOL)application:(UIApplication*)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions {
    
    // Register for Apple Push Notification Service
    [application registerForRemoteNotificationTypes:(UIRemoteNotificationTypeAlert | UIRemoteNotificationTypeSound)];
    
    //your application specific code
    
    return YES;
}

- (void)application:(UIApplication*)application didRegisterForRemoteNotificationsWithDeviceToken:deviceToken
{
    // If you are testing development (sandbox) notifications, you should instead pass development:YES
    
#if DEBUG
    [SZSmartAlertUtils registerDeviceToken:deviceToken development:YES];
#else
    [SZSmartAlertUtils registerDeviceToken:deviceToken development:NO];
#endif
}

- (void)handleNotification:(NSDictionary*)userInfo {
    if ([[UIApplication sharedApplication] applicationState] != UIApplicationStateActive) {
        if ([SZSmartAlertUtils openNotification:userInfo]) {
            NSLog(@"Socialize handled the notification (background).");
            
        } else {
            NSLog(@"Socialize did not handle the notification (background).");
            
        }
    } else {
        
        NSLog(@"Notification received in foreground");
        
        // You may want to display an alert or other popup instead of immediately opening the notification here.
        
        if ([SZSmartAlertUtils openNotification:userInfo]) {
            NSLog(@"Socialize handled the notification (foreground).");
        } else {
            NSLog(@"Socialize did not handle the notification (foreground).");
        }
    }
}

- (void)application:(UIApplication *)application didReceiveRemoteNotification:(NSDictionary *)userInfo {
    
    // Handle Socialize notification at foreground
    [self handleNotification:userInfo];
}

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

    // ...

    // Register for Apple Push Notification Service
    [application registerForRemoteNotificationTypes:(UIRemoteNotificationTypeAlert | UIRemoteNotificationTypeSound)];

    // Handle Socialize notification at launch
    NSDictionary *userInfo = [launchOptions objectForKey:UIApplicationLaunchOptionsRemoteNotificationKey];
    if (userInfo != nil) {
        [self handleNotification:userInfo];
    }
    
    //your application specific code
    
    return YES;
}

Defining an Entity Loader¶

For Smart Alerts to work correctly, you must define an entity loader.

Defining an Entity Loader allows Socialize’s UI objects to link back to your application’s objects. The entity loader block is called from certain builtin Socialize UI Controls when it needs to show information about an entity. It is currently shown in the comment details activity listing table view.

Typically, you should have your own view controller for showing detail on an entity in your app. You should push a view controller onto the stack.

If you’d just like to see notifications in action, you can use the bundled entity example entity loader called SampleEntityLoader. This class is not intended for use in a production app.

Copy the lines below to add an entity loader

- (BOOL)application:(UIApplication*)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions {
    
    // ...
    
    // Register for Apple Push Notification Service
    [application registerForRemoteNotificationTypes:(UIRemoteNotificationTypeAlert | UIRemoteNotificationTypeSound)];

    // Handle Socialize notification at launch
    NSDictionary *userInfo = [launchOptions objectForKey:UIApplicationLaunchOptionsRemoteNotificationKey];
    if (userInfo != nil) {
        [self handleNotification:userInfo];
    }

    // Specify a Socialize entity loader block
    [Socialize setEntityLoaderBlock:^(UINavigationController *navigationController, id<SocializeEntity>entity) {
        
        SampleEntityLoader *entityLoader = [[SampleEntityLoader alloc] initWithEntity:entity];

        if (navigationController == nil) {
            UINavigationController *navigationController = [[UINavigationController alloc] initWithRootViewController:entityLoader];
            [self.window.rootViewController presentModalViewController:navigationController animated:YES];
        } else {
            [navigationController pushViewController:entityLoader animated:YES];
        }
    }];
    
    // Optionally specify a new comments notification override (An SZCommentsListViewController plus comment detail will be shown by default)
//    [Socialize setNewCommentsNotificationBlock:^(id<SocializeComment> comment) {
//        NSLog(@"Received new comments notification. Doing nothing.");
//    }];

    
    return YES;
}

For some applications, it might happen that an entities are not always available. Socialize provides the ability to selectively disable loading for a given entity. Should you find you need this, you can do this by defining a “Can Load Entity” block, as follows

- (BOOL)application:(UIApplication*)application didFinishLaunchingWithOptions:(NSDictionary*)launchOptions {
    
    // ...

    [Socialize setCanLoadEntityBlock:^BOOL(id<SocializeEntity> entity) {
        return ![entity.name isEqualToString:@"DeletedEntity"];
    }];
    
    return YES;
}

Testing SmartAlerts™¶

In order to test that SmartAlerts™ are working correctly you’ll want to first to get your app compiled and installed on a physical device and working on the simulator as well.

1. Open apps on both the simulator and the physical device.
2. From the physical device leave a comment on an entity. Make sure you to subscribe to entity when you leave a comment. You should now be subscribed to the entity and will receive notifications when someone else leaves a comment.
3. On the simulator add a comment to the same the entity from which you did on the physical device.
4. Notifications are sent out asynchronously in a queue. It may take 2-3 minutes to receive your notification.

Sending Targeted SmartAlerts™¶

If you would like to send a target alert your users, you can do so. Simply click “Send SmartAlert” from the developer dashboard. You can direct the user to either a specific entity or a URL of your choosing. Directing to an entity will trigger your entity loader. Directing to a URL will send the user to a web view to a URL of your choosing. You can either target all of your users or specify a comma-separated list of user ids.

Subscribing to Entity Subscribers (Without Comments)¶

It’s possible to subscribe your users to specific entities, and send alerts only to users who have subscribed to these entities. The builtin UI controllers do not expose this functionality, but if you wish, you can handle the subscription on your own.

1. Open the Socialize web dashboard for your app at getsocialize.com / “My Apps”
2. Select the “Entities” tab
3. Navigate to or search for your entity by key or id
4. Click ‘Send SmartAlert’ underneath ‘I want to...’ on the right
5. Fill out the alert content
6. Check ‘Send only to explicitly subscribed users’

Overriding the Notification Display Process¶

Because of the asynchronous nature of notifications, Socialize displays the associated view controllers is the main window of the application by default. If you’d like to override this behavior, you can do so by specifying a global display object. See Overriding Global Display Behavior for more info.

Programmatically Dismissing Notification Popups¶

You might find that you’d like to dismiss all Socialize notifications outside of the normal user flow. As a convenience, you can dismiss all Socialize notification popups programatically by posting a SocializeShouldDismissAllNotificationControllersNotification.

#import <Socialize/Socialize.h>

- (void)dismissSocializeNotifications {
    
    [[NSNotificationCenter defaultCenter] postNotificationName:SocializeShouldDismissAllNotificationControllersNotification object:nil];

}

Troubleshooting Notifications¶

If you are not receiving notifications, there are some simple ways to troubleshoot problems. We also have a vibrant developer community and support here: http://support.getsocialize.com support who can help.

Additionally, here some common errors you might encounter:

- (void)application:(UIApplication*)application didFailToRegisterForRemoteNotificationsWithError:(NSError*)error
{
    NSLog(@"Error Register Notifications: %@", [error localizedDescription]);
}

Everything looks ok, but I am still not receiving notifications¶

You can try sending a push directly to your device. You can open the device logs from Xcode by attaching your device, selecting Window -> Organizer, choosing your device, and selecting “Console”. The message is

Mar 28 12:16:57 AppName[3354] : Socialize: device token FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF successfully registered with server

You can then send a notification from the web interface, in the “View Debugger” section of the web interface.

Please go to support.getsocialize.com for additional support.