Package Exports

node-gcm

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (node-gcm) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

node-gcm

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

Installation

$ npm install node-gcm

##Requirements

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

Usage

var gcm = require('node-gcm');

var message = new gcm.Message();
var sender = new gcm.Sender('insert Google Server API Key here');
var registrationIds = [];

// Optional
message.addData('key1','message1');
message.addData('key2','message2');
message.collapseKey = 'demo';
message.delayWhileIdle = true;
message.timeToLive = 3;

// At least one required
registrationIds.push('regId1');
registrationIds.push('regId2'); 

/**
 * Parameters: message-literal, registrationIds-array, No. of retries, callback-function
 */
sender.send(message, registrationIds, 4, function (err, result) {
    console.log(result);
});

And without retries

sender.sendNoRetry(message, registrationIds-array, function (err, result) {
    console.log(result);
});

Contribute!

If you don't want to create a GitHub-Account, but still feel the urge to contribute... no problem! Just send me an email with your pull request from your private repository. Of course, you can also send me a patch directly inline your mail. Any help is much appreciated!

Contributors

License

(The MIT License)

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.

Changelog

0.9.4:

fix TypeError
updated contributors
updated README

0.9.3:

new callback-style (Please check the example above)
fixes various issues (Read commit messages)
not making a distinction between a single and multiple result makes it easier for application-land code to handle

0.9.2:

added error handler to HTTPS request to handle DNS exceptions
added multicast-messaging

0.9.1:

first release