Push

Push helps you reach out to your users in a timely fashion with important messages. You can use it to inform users about updates to some piece of data, about new services available nearby or that they are winners in a game. Using Custom server code you can set up triggers which send push notifications to a targeted set of people based on changes in the data you specify.

Kinvey brings Android Push Notifications to you through an integration with Google Cloud Messaging (GCM) and iOS Push Notifications through an integration with AWS SNS. While push notifications can only be configured to be used by either iOS or Android devices, our APIs provide support for registering/unregistering devices and associating them with Kinvey users.

Setup

Console Set Up

When using Apple Push Notification Service (APNS) you will get two push certificates; one for development and one for production/ad-hoc. These certificates require push notifications to be sent to different servers depending on if your app is in development or production.

The production certificate is only usable if your app is in the App Store.

  1. Generate an Apple Push Certificate .p12 file for your app (instructions).
  2. After you export the .p12 file, on Kinvey's console navigate to Engagement and select Push.
  3. Click Configure Push.
  4. In the iOS section drag your .p12 file generated in step 1 where it says Drag here or click to upload a .p12 file.
  5. Click Save
  6. When you are ready to deploy your app, use your production/ad-hoc certificate. Export the .p12 file, and upload that to our service. Then select production as the certificate type and click Save. Deploying your application is a one-time action and cannot be undone.

App Set Up

To configure push in your app, pass the configuration in using Kinvey.sharedClient.push.registerForPush(). This is usually done inside application:didFinishLaunchingWithOptions: after initializing Client.

func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplicationLaunchOptionsKey : Any]? = nil) -> Bool {
    //Your App Setup...

    Kinvey.sharedClient.initialize(appKey: "<#Your app key#>", appSecret: "<#Your app secret#>") { (result: Result<User?, Swift.Error>) in
        switch result {
        case .success(let user):
            if let user = user {
                print("User: \(user)")
            }
        case .failure(let error):
            print("Error: \(error)")
        }
    }

    let completionHandler = { (result: Result<Bool, Swift.Error>) in
        switch result {
        case .success(let succeed):
            print("succeed: \(succeed)")
        case .failure(let error):
            print("error: \(error)")
        }
    }
    if #available(iOS 10.0, *) {
        Kinvey.sharedClient.push.registerForNotifications(options: nil, completionHandler: completionHandler)
    } else {
        Kinvey.sharedClient.push.registerForPush(completionHandler: completionHandler)
    }

    return true
}

Production vs Development Push

When using Apple Push Notification Service (APNS) you will get two push certificates; one for development and one for production/ad-hoc. These certificates require push notifications to be sent to different servers depending on if your app is in development or production.

Because of this we need to provision the app differently for each mode.

Triggering Push Notifications

In addition to using the Console, you can trigger a push notification from Business Logic or a Flex service. This approach allows for greater flexibility as it makes it possible to schedule push notifications, to tie them down to various data events, and to set advanced options supported by Android and iOS.

You can send push notification from either collection hooks, effectively tying the notification to a data event, or custom endpoints which you can call manually or programmatically when needed.

The methods for sending push notifications are provided by the push module available in both Business Logic and the Flex SDK. They include send(), sendMessage(), sendPayload(), broadcastPayload(), and broadcastMessage(). Check the module's reference for detailed information.

The following code uses the onPreSave() before-processing collection hook to send a simple push notification to all users who fancy the winning team. Instead of saving any data to the data store, this request just causes the push notification to be sent.

function onPreSave(request,response,modules){
    var collectionAccess = modules.collectionAccess
   , userCollection = collectionAccess.collection('user')
   , utils = modules.utils
   , push = modules.push
   , template = '{{name}}, the {{team}} just won!'
   , pushedMessageCount = 0
   , userCount;


   // Find all users whose favoriteTeam matches the incoming request's winning team
   userCollection.find({"favoriteTeam": request.body.winningTeam}, function(err, userDocs){
     // Total number of messages to send
     userCount = userDocs.length;

     // Each message is customized
     userDocs.forEach(function(doc){
       var values = {
          name: doc.givenName,
          team: doc.favoriteTeam
       };

       // Render the message to send
       var message = utils.renderTemplate(template, values);

       // Send the push
       push.send(doc, message);

       // Keep track of how many pushes are sent
       pushedMessageCount++;

       // Reduce the number of users left to push to
       userCount--;
       if (userCount <= 0){
         // All pushes sent out, complete the request
         response.body = {"message": "Attempted to push " + pushedMessageCount + " messages."};
         response.complete(200);
        }
     });
  });
}

The body of the request must have a winningTeam property. For example:

{
  "winningTeam": "Boston Red Sox"
}

Users are expected to have a givenName property and a favoriteTeam property.

The Push notification will be similar to:

Joe, the Kansas City Royals just won!

Receiving Push Notifications

In order to receive and handle push notifications in your application, you have to implement the application(didReceiveRemoteNotification:) method in your app delegate, as described below

func application(_ application: UIApplication, didReceiveRemoteNotification userInfo: [AnyHashable : Any]) {
    // Push Notification handling code should be performed here
}

For more details, please read Apple's documentation.

App Badge Management

You can have your app icon display a red badge with the number of unread push notifications. This is done through the Push object.

To set the badge to a particular number:

Kinvey.sharedClient.push.badgeNumber = 100 //sets to 100

To clear the badge:

Kinvey.sharedClient.push.resetBadgeNumber() //sets badgeNumber to 0

Disabling Push Notifications

The unregister operation allows you to remove the current device from the user account's list of registrations, effectively stopping the user from receiving push notifications on the device. The operation is useful when the user has opted out of receiving this kind of notifications or for another reason. Unregister requires an active user. It will return an error if you call it after logging out the user.

Kinvey.sharedClient.push.unRegisterDeviceToken(options: nil)
Got a question?