https://github.com/h2soft/node-gcm

https://github.com/h2soft/node-gcm

Last synced: 18 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/h2soft/node-gcm
• Owner: h2soft
• License: mit
• Created: 2012-06-29T10:00:13.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2019-04-03T21:33:37.000Z (over 5 years ago)
• Last Synced: 2024-04-29T09:03:22.960Z (7 months ago)
• Language: JavaScript
• Size: 132 KB
• Stars: 68
• Watchers: 11
• Forks: 20
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
node-gcm

========

An interface for "Google Cloud Messaging for Android" on Node.js

## Installation

Via [npm][1]:

    $ npm install gcm

As a submodule of your project

    $ git submodule add http://github.com/h2soft/node-gcm.git gcm

    $ git submodule update --init

## Usage

    var GCM = require('gcm').GCM;

    var apiKey = '';

    var gcm = new GCM(apiKey);

    var message = {

        registration_id: 'Device registration id', // required

        collapse_key: 'Collapse key', 

        'data.key1': 'value1',

        'data.key2': 'value2'

    };

    

    gcm.send(message, function(err, messageId){

        if (err) {

            console.log("Something has gone wrong!");

        } else {

            console.log("Sent with message ID: ", messageId);

        }

    });

See [GCM documentation][2] for details.

## Credits

Written and maintained by [Changshin Lee][3].

Thanks to Yury Proshchenko for his great work on [node-c2dm][4], from which this project stems.

## License

The MIT License

Copyright (c) 2012 Changshin Lee ([email protected])

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.

[1]: http://github.com/isaacs/npm

[2]: http://developer.android.com/guide/google/gcm/index.html

[3]: mailto:[email protected]

[4]: https://github.com/SpeCT/node-c2dm

## Changelog

1.0.1:

  - Merge pull request from https://github.com/h2soft/node-gcm/commit/3e38578985812931e361c78165d62fda30a30064 (thanks to @hannesgassert)

1.0.0:

  - Initial release