Are you happy with your logging solution? Would you help us out by taking a 30-second survey? Click here

node-gcm

A NodeJS wrapper library port to send data to Android devices via Google Cloud Messaging

Subscribe to updates I use node-gcm


Statistics on node-gcm

Number of watchers on Github 13
Number of open issues 0
Main language JavaScript
Open pull requests 0+
Closed pull requests 0+
Last commit over 6 years ago
Repo Created about 6 years ago
Repo Last Updated over 1 year ago
Size 66 KB
Homepage https://github.co...
Organization / Authorinstagram
Contributors7
Page Updated
Do you use node-gcm? Leave a review!
View on github
Fresh, new opensource launches 🚀🚀🚀
Trendy new open source projects in your inbox! View examples

Subscribe to our mailing list

Evaluating node-gcm for your project? Score Explanation
Commits Score (?)
Issues & PR Score (?)

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');

// create a message with default values
var message = new gcm.Message();

// or with object values
var message = new gcm.Message({
    collapseKey: 'demo',
    delayWhileIdle: true,
    timeToLive: 3,
    data: {
        key1: 'message1',
        key2: 'message2'
    }
});

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

// Optional
// add new key-value in data object
message.addDataWithKeyValue('key1','message1');
message.addDataWithKeyValue('key2','message2');

// or add a data object
message.addDataWithObject({
    key1: 'message1',
    key2: 'message2'
});

// or with backwards compability of previous versions
message.addData('key1','message1');
message.addData('key2','message2');


message.collapseKey = 'demo';
message.delayWhileIdle = true;
message.timeToLive = 3;
// END Optional

// 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)

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.

Changelog

0.9.6:

  • fixed undefined data var
  • made constructor argument optional
  • added back addData method
  • updated README
  • updated contributors

0.9.5:

  • change addData to addDataWithKeyValue
  • add new function addDataWithObject
  • message object can be initialised with another object
  • updated contributors

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
node-gcm questions on Stackoverflow (View All Questions)
  • Send android notification with node-gcm without collapsing them
  • node-gcm: send PushNotification for all device
  • Android Push Notifications not appearing when app is fully closed (using node-gcm)
  • Node-gcm and Nodejs, issues sending images
  • Phonegap Plugin Push & Node-gcm NotRegistered
  • Keep getting NotRegistered - Node gcm
  • Browser: Google Cloud Messaging/node-gcm - data is always null
  • node-gcm : TypeError: gcm.Message is not a function
  • Node GCM with proxy - port 443 disabled
  • Phonegap require is not defined with PushPlugin and node-gcm
  • Phonegap Pushnotification + node-gcm: group notifications
  • Cordova Push Notifications Plugin Node-gcm for ios
  • Push notification android cordova with node-gcm
  • Unable to push GCM notification using node-gcm
  • GCM message sent from node-gcm server but not received
  • Can I use node or node-gcm to recieve upstream messages from an android device?
  • node-gcm server receive error: MismatchSenderId
  • I am trying to implement Push Notification using "node-gcm" package in Meteor.js
  • node-gcm send message only 1 device?
  • Node.JS node-gcm-Service only sends to one device
  • can't receive data from node-gcm?
  • node-gcm sending successfully but I do not know how to get the data from the client side
  • Using node-gcm behind a proxy
  • Send payload notification with node-gcm to android device
  • Cannot find module 'node-gcm'
node-gcm list of languages used
Other projects in JavaScript