Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

gcm-test

0.1.4 • Public • Published

Node GCM CLI Build Status Dependency Status Coverage Status

NodeJs CLI to test gcm on your android application

Installation

$ npm install gcm-test

Usage

 
var gcmTest = require('gcm-test');
 
gcmTest('hello world', ['123'], {
  apiKey: '123'
}, function(err, response){
  console.log(err, response);
});
 
// send data as an object
gcmTest({
  message: 'hello world',
  path: 'landing'
}, ['123'], {
  apiKey: '123'
}, function(err, response){
  console.log(err, response);
});

CLI

$ npm install -g gcm-test

$ gcm --help

  Usage: cli [options]

  Options:

    -h, --help                   output usage information
    -V, --version                output the version number
    -m, --message <message>      message that you wish to send (string or key-value), eg: --message="message:this is test,path:landing"
    -k, --apiKey <key>           google api key
    -r, --registrationids <ids>  comma separated ids, if more than one
    -c, --collapseKey <key>      collapse key for android
    -d, --delayWhileIdle         `If the device is connected but idle, the message will still be delivered right away unless the delayWhileIdle flag is set to true`, (default to false)
    -t, --timeToLive <time>      alive time of this notification
    -D, --dryRun                 for debug/ test purpose, it allows for sending a message without really sending it (default to false)
    -j, --json                   message is json string (boolean), default to false. (Required if message are key-values)

Examples

$ gcm -m "message:testing,path:landing" -j -k <key> -r <registrationid>

Options

  • apiKey : google api key
  • collapseKey : collapse key for message to send to the same registration id
  • delayWhileIdle : if true, message will be send to user when device is active
  • timeToLive : maximum period of time for which GCM will store and try to deliver the message (from 0 to 2,419,200 seconds)
  • dryRun : for debug/ test purpose, it allows for sending a message without really sending it

License

The MIT License (MIT)

Copyright (c) 2014 yujinlim

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.

Install

npm i gcm-test

DownloadsWeekly Downloads

1

Version

0.1.4

License

MIT

Last publish

Collaborators

  • avatar