Skip to content

Commit 3a5fe3f

Browse files
committed
Updated the usage section to fit the real code
1 parent 141e998 commit 3a5fe3f

1 file changed

Lines changed: 14 additions & 31 deletions

File tree

README.md

Lines changed: 14 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -49,21 +49,17 @@ gcm.send(message, { registrationTokens: regTokens }, function (err, response) {
4949
## Usage
5050

5151
```js
52-
var gcm = require('node-gcm');
52+
var gcm = require('node-gcm')('insert Google Server API Key here');
5353

54-
// Create a message
55-
// ... with default values
56-
var message = new gcm.Message();
57-
58-
// ... or some given values
59-
var message = new gcm.Message({
60-
collapseKey: 'demo',
54+
// Create a message (all possible values shown)
55+
var message = {
56+
collapse_key: 'demo',
6157
priority: 'high',
62-
contentAvailable: true,
63-
delayWhileIdle: true,
64-
timeToLive: 3,
65-
restrictedPackageName: "somePackageName",
66-
dryRun: true,
58+
content_available: true,
59+
delay_while_idle: true,
60+
time_to_live: 3,
61+
restricted_package_name: "somePackageName",
62+
dry_run: true,
6763
data: {
6864
key1: 'message1',
6965
key2: 'message2'
@@ -73,21 +69,7 @@ var message = new gcm.Message({
7369
icon: "ic_launcher",
7470
body: "This is a notification that will be displayed ASAP."
7571
}
76-
});
77-
78-
// Change the message data
79-
// ... as key-value
80-
message.addData('key1','message1');
81-
message.addData('key2','message2');
82-
83-
// ... or as a data object (overwrites previous data object)
84-
message.addData({
85-
key1: 'message1',
86-
key2: 'message2'
87-
});
88-
89-
// Set up the sender with you API key
90-
var sender = new gcm.Sender('insert Google Server API Key here');
72+
};
9173

9274
// Add the registration tokens of the devices you want to send to
9375
var registrationTokens = [];
@@ -96,23 +78,24 @@ registrationTokens.push('regToken2');
9678

9779
// Send the message
9880
// ... trying only once
99-
sender.sendNoRetry(message, { registrationTokens: registrationTokens }, function(err, response) {
81+
gcm.sendNoRetry(message, { registrationTokens: registrationTokens }, function(err, response) {
10082
if(err) console.error(err);
10183
else console.log(response);
10284
});
10385

10486
// ... or retrying
105-
sender.send(message, { registrationTokens: registrationTokens }, function (err, response) {
87+
gcm.send(message, { registrationTokens: registrationTokens }, function (err, response) {
10688
if(err) console.error(err);
10789
else console.log(response);
10890
});
10991

11092
// ... or retrying a specific number of times (10)
111-
sender.send(message, { registrationTokens: registrationTokens }, 10, function (err, response) {
93+
gcm.send(message, { registrationTokens: registrationTokens }, 10, function (err, response) {
11294
if(err) console.error(err);
11395
else console.log(response);
11496
});
11597
```
98+
11699
## Recipients
117100

118101
You can send push notifications to various recipient types by providing one of the following recipient keys:

0 commit comments

Comments
 (0)