node-gcm

a Node.JS wrapper library-port for Google Cloud Messaging for Android

node-gcm

node-gcm is a Node.JS library for Google Cloud Messaging for Android, which replaces Cloud 2 Device Messaging (C2DM).

$ npm install node-gcm

##Requirements

An Android device running 2.2 or newer and an API key as per GCM getting started guide.

According to below Usage reference, we could create such application:

var gcm = require('node-gcm');
 
var message = new gcm.Message();
 
message.addData('key1', 'msg1');
 
var regIds = ['YOUR_REG_ID_HERE'];
 
// Set up the sender with you API key 
var sender = new gcm.Sender('YOUR_API_KEY_HERE');
 
//Now the sender can be used to send messages 
sender.send(message, regIds, function (errresult) {
    if(err) console.error(err);
    else    console.log(result);
});
 
sender.sendNoRetry(message, regIds, function (errresult) {
    if(err) console.error(err);
    else    console.log(result);
});
var gcm = require('node-gcm');
 
// Create a message 
// ... with default values 
var message = new gcm.Message();
 
// ... or some given values 
var message = new gcm.Message({
    collapseKey: 'demo',
    delayWhileIdle: true,
    timeToLive: 3,
    data: {
        key1: 'message1',
        key2: 'message2'
    }
});
 
// Change the message data 
// ... as key-value 
message.addData('key1','message1');
message.addData('key2','message2');
 
// ... or as a data object (overwrites previous data object) 
message.addData({
    key1: 'message1',
    key2: 'message2'
});
 
// Change the message variables 
message.collapseKey = 'demo';
message.delayWhileIdle = true;
message.timeToLive = 3;
message.dryRun = true;
 
// Set up the sender with you API key 
var sender = new gcm.Sender('insert Google Server API Key here');
 
// Add the registration IDs of the devices you want to send to 
var registrationIds = [];
registrationIds.push('regId1');
registrationIds.push('regId2');
 
// Send the message 
// ... trying only once 
sender.sendNoRetry(message, registrationIds, function(errresult) {
  if(err) console.error(err);
  else    console.log(result);
});
 
// ... or retrying 
sender.send(message, registrationIds, function (errresult) {
  if(err) console.error(err);
  else    console.log(result);
});
 
// ... or retrying a specific number of times (10) 
sender.send(message, registrationIds, 10, function (errresult) {
  if(err) console.error(err);
  else    console.log(result);
});

Notice that you can at most send notifications to 1000 registration ids at a time. This is due to a restriction on the side of the GCM API.

 
var message = new gcm.Message();
 
// Add notification payload as key value 
message.addNotification('title', 'Alert!!!');
message.addNotification('body', 'Abnormal data access');
message.addNotification('icon', 'ic_launcher');
 
// as object 
message.addNotification({
  title: 'Alert!!!',
  body: 'Abnormal data access',
  icon: 'ic_launcher'
});
 
ParameterPlatformUsageDescription
titleAndroid, iOS (Watch)equired (Android), Optional (iOS), stringIndicates notification title. This field is not visible on iOS phones and tablets.
bodyAndroid, iOSOptional, stringIndicates notification body text.
iconAndroidRequired, stringIndicates notification icon. On Android: sets value to myicon for drawable resource myicon.png.
soundAndroid, iOSOptional, stringIndicates sound to be played. Supports only default currently.
badgeiOSOptional, stringIndicates the badge on client app home icon.
tagAndroidOptional, stringIndicates whether each notification message results in a new entry on the notification center on Android. If not set, each request creates a new notification. If set, and a notification with the same tag is already being shown, the new notification replaces the existing one in notification center.
colorAndroidOptional, stringIndicates color of the icon, expressed in #rrggbb format
click_actionAndroid, iOSOptional, stringThe action associated with a user click on the notification. On Android, if this is set, an activity with a matching intent filter is launched when user clicks the notification. For example, if one of your Activities includes the intent filter: (Appendix:1)Set click_action to OPEN_ACTIVITY_1 to open it. If set, corresponds to category in APNS payload.
body_loc_keyiOSOptional, stringIndicates the key to the body string for localization. On iOS, this corresponds to "loc-key" in APNS payload.
body_loc_argsiOSOptional, JSON array as stringIndicates the string value to replace format specifiers in body string for localization. On iOS, this corresponds to "loc-args" in APNS payload.
title_loc_argsiOSOptional, JSON array as stringIndicates the string value to replace format specifiers in title string for localization. On iOS, this corresponds to "title-loc-args" in APNS payload.
title_loc_keyiOSOptional, stringIndicates the key to the title string for localization. On iOS, this corresponds to "title-loc-key" in APNS payload.

Notice notification payload defined in GCM Connection Server Reference

To enable debug mode (print requests and responses to and from GCM), set the DEBUG environment flag when running your app (assuming you use node app.js to run your app):

DEBUG=node-gcm node app.js

Bitcoin: 13iTQf7tDhrKgibw2Y3U5SyPJa7R8sQmHQ

Do you see an issue in the code that is not represented by the issues, please do create it.

If you want to help solve an issue, please submit a Pull Request (PR). If the PR aims to solve a known issue, please refer this issue in your description. Make sure that your PR explains what problem it solves, and any key decisions made in regards to this. Make the PR early so maintainers and other contributors get a chance to give input on your code and how it fits in the bigger picture.

Any help is much appreciated!

(The MIT License)

Copyright (c) 2013 Marcus Farkas <toothlessgear@finitebox.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.