node package manager

bluemix-push-notifications

BluemixPushNotifications

Build Status Build Status

Summary

BluemixPushNotifications is a Node.js SDK for sending push notifications via Bluemix Push Notifications services.

Installation

npm install bluemix-push-notifications --save

Usage

var PushNotifications = require('bluemix-push-notifications').PushNotifications;
var Notification = require('bluemix-push-notifications').Notification;

Initialize PushNotifications with details about your Bluemix Push Notifications service.

var myPushNotifications = new PushNotifications(PushNotifications.Region.US_SOUTH, "your-bluemix-app-guid", "your-push-service-appSecret");

Note: The first parameter in the initializer is the Bluemix region where the Push Notifications service is hosted. The three options are PushNotifications.Region.US_SOUTH, PushNotifications.Region.UK, and PushNotifications.Region.SYDNEY. If null is supplied for the last 2 parameters, their values will be automatically retrieved from the Bluemix app's environment variables, provided that your Node.js app is bound to the Bluemix app.

Next, create the push notification that you want to broadcast by supplying the alert message you want displayed.

var notificationExample = new Notification("Testing BluemixPushNotifications");

An optional URL may be supplied with the alert.

notificationExample.setUrl("www.example.com");

You can specify which devices the notification should be sent to and customize the alert they receive.

// setTarget(deviceIds, platforms, tagNames) 
notificationExample.setTarget(["device1", "device2"], [Notification.TargetPlatform.Apple, Notification.TargetPlatform.Google], ["tag1", "tag2"]);
// setApnsSettings(badge, category, iosActionKey, sound, type, payload) 
notificationExample.setApnsSettings(1, "category", "iosActionKey", "sound.mp3", Notification.ApnsType.DEFAULT, {key: "value"});
// setGcmSettings(collapseKey, delayWhileIdle, payload, priority, sound, timeToLive) 
notificationExample.setGcmSettings("collapseKey", true, "payload", Notification.GcmPriority.DEFAULT, "sound.mp3", 1.0);

Finally, send the Push notification.

myPushNotifications.send(notificationExample, function(error, response, body) {
    console.log("Error: " + error);
    console.log("Response: " + JSON.stringify(response));
    console.log("Body: " + body);
});

License

Copyright 2016 IBM Corp.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.