Node-GCMService
Description
Node.js wrapper to send notification to Android devices using Google Cloud Messaging service.
Badges
Installation
npm install node-gcm-service
Requirements
The only thing you need is a google server api key. For more information go to GCM getting started guide.
Usage
Require the module
var gcm = ;
Create a message object with default values and set all variables after, or with another object:
- with default values
var message = ; // set data with another objectmessage; // add new key-value to data if key does not existsmessage; // set collapse keymessage; // set dry runmessage; // set delay while idlemessage;
- with another object (undefined variables will be set with the default values)
var message = collapse_key: 'test' data: key1: 'value1' delay_while_idle: true time_to_live: 34 dry_run: false;
Create a sender object with default values and set the api key after, or with another object:
- with default values
var sender = ; // set api keysender;
- with another object
var sender = key: 'my_api_key';
Important : you can set the endpoint and end path URLs if Google change these URLs
And finally send the message to the specified registration id(s) with retries or not, in JSON format or plain-text format :
- with retries in JSON format
sender;
- without retries in plain-text format
sender;
GCM Response
Multicast (JSON response)
- GCM response
"multicast_id": 216 "success": 3 "failure": 3 "canonical_ids": 1 "results": "message_id": "1:0408" "error": "Unavailable" "error": "InvalidRegistration" "message_id": "1:1516" "message_id": "1:2342" "registration_id": "32" "error": "NotRegistered"
- module response
"multicast_id": 216 "success_length": 3 "failures_length": 3 "failures": "NotRegistered": "42" "Unavailable": "8" "InvalidRegistration": "15" "canonical_ids_length": 1 "canonical_ids": "message_id": "1:2342" "registration_id": "23" "new_registration_id": "32"
Simple (plain-text response)
- GCM response
id=1:2342
registration_id=32
- module response
"id": "1:2342" "registration_id": "32" "old_registration_id": "14"
Message class methods
toJSON()
: JSON representation of the objecttoString()
: String representation of the objectaddNewKeyValue('key', 'value')
: add key-value in data object, return false if key can not be addedsetDataWithObject({…})
: set data object with a new objectsetCollapseKey('key')
: set collapse_keysetDryRun(true|false)
: set dry_runsetRestrictedPackageName('package_name')
: set restricted_package_namesetTimeToLive(12345)
: set time_to_livesetDelayWhileIdle(true|false)
: set delay_while_idle
Sender class methods
setAPIKey('key')
: set api keysetGCMEndpoint('endpoint')
: set GCM endpoint (default: https://android.googleapis.com)setGCMEndPath('endpath')
: set GCM end path (default: /gcm/send)sendMessage(message, registration_ids, retries, callback)
: send the notification to the registration id(s) with or without retries in JSON or plain-text format and return the response data or an errorsetBackoffDelay(value)
: set the back-off delay in milliseconds (default: 1000)setBackoffFactor(value)
: set the back-off factor by which the back-off delay should be multiplied per attempt (default: 1.2)setAttempts(value)
: set the number of retries
License
(The MIT License)
Copyright (C) 2013 PinchProject
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.
Credits
This module was written based on node-gcm
Change log
v0.2.8
- fix a bug with an
if
statement condition
v0.2.6
- using
request
module v2.25.0 to avoid parsing error - add
details
attribute on Error object when Google GCM server respond with400: BAD_REQUEST
- code refactoring
- update modules
- update documentation
v0.2.3
- update request module version
v0.2.1
- add the old registration_id to the plain-text response object
v0.2.0
- split-up the registration_ids array from the message class
- send notification to more than 1000 devices and return a unified result
v0.1.4
- update documentation
- rename files to resolve an issue
- when creating a new Message or Sender object with another object, more checks have been added (check all object property) and default value will be used if object property does not exists
v0.1.3
- resolved some issue.
v0.1.2
- modified the structure of the GCM response (JSON or plain-text).
v0.1.1
- update documentation.
v0.1.0
- first release.