The following flowchart attempts to give you a picture of what happens when a push message arrives on your device when you have an app using phonegap-plugin-push.
- The push plugin receives the data from the remote push service and calls all of your
notificationevent handlers. - The message is not displayed in the devices notification center as that is not normal behaviour for Android or iOS.
- The push plugin receives the data from the remote push service and checks to see if there is a title or message in the data received. If there is then the message will be displayed in the devices notification center.
- Then the push plugin checks to see if the app is running. If the user has killed the application then no further processing of the push data will occur.
- If they app is running in the background the push plugin then checks to see if
content-availableexists in the push data. - If
content-availableis set to1then the plugin calls all of yournotificationevent handlers.
- The app starts.
- Then the plugin calls all of your
notificationevent handlers.
Note: if the push payload contained
content-available: 1then yournotificationevent handler has already been called. It is up to you to handle the double event.
Some ways to handle this double event are:
- don't include title/message in the push so it doesn't show up in the shader.
- send two pushes, one to be processed in the background the other to show up in the shade.
- include a unique ID in your push so you can check to see if you've already processed this event.
By default the icon displayed in your push notification will be your apps icon. So when you initialize the plugin like this:
var push = PushNotification.init({
"android": {
"senderID": "12345679"
},
browser: {
pushServiceURL: 'http://push.api.phonegap.com/v1/push'
},
"ios": {
"alert": "true",
"badge": "true",
"sound": "true"
},
"windows": {}
});The result will look much like this:
This is because Android now uses Material design and the default icon for push will be completely white.
In order to get a better user experience you can specify an alternate icon and background color to be shown when receiving a push notification. The code would look like this:
var push = PushNotification.init({
"android": {
"senderID": "123456789",
"icon": "phonegap",
"iconColor": "blue"
},
browser: {
pushServiceURL: 'http://push.api.phonegap.com/v1/push'
},
"ios": {
"alert": "true",
"badge": "true",
"sound": "true"
},
"windows": {}
});Where icon is the name of an image in the Android drawables folder. Writing a hook to describe how to copy an image to the Android drawables folder is out of scope for this README but there is an excellent tutorial that you can copy.
iconColor is one of the supported formats #RRGGBB or #AARRGGBB or one of the following names: 'red', 'blue', 'green', 'black', 'white', 'gray', 'cyan', 'magenta', 'yellow', 'lightgray', 'darkgray', 'grey', 'lightgrey', 'darkgrey', 'aqua', 'fuchsia', 'lime', 'maroon', 'navy', 'olive', 'purple', 'silver', 'teal'. iconColor is supported on Android 5.0 and greater.
Please follow the Android icon design guidelines when creating your icon.
Additionally, each push can include a large icon which is used to personalize each push. The location of the image may one of three types.
The first is the drawables folder in your app. This JSON sent from GCM:
{
"registration_ids": ["my device id"],
"data": {
"title": "Large Icon",
"message": "Loaded from drawables folder",
"image": "twitter"
}
}Here is an example using node-gcm that sends the above JSON:
var gcm = require('node-gcm');
// Replace these with your own values.
var apiKey = "replace with API key";
var deviceID = "my device id";
var service = new gcm.Sender(apiKey);
var message = new gcm.Message();
message.addData('title', 'Large Icon');
message.addData('message', 'Loaded from drawables folder.');
message.addData('image', 'twitter');
service.send(message, { registrationTokens: [ deviceID ] }, function (err, response) {
if(err) console.error(err);
else console.log(response);
});Would look for the twitter image in the drawables folder and produce the following notification.
The second is the assets folder in your app. This JSON sent from GCM:
{
"registration_ids": ["my device id"],
"data": {
"title": "Large Icon",
"message": "Loaded from assets folder",
"image": "www/image/logo.png"
}
}Here is an example using node-gcm that sends the above JSON:
var gcm = require('node-gcm');
// Replace these with your own values.
var apiKey = "replace with API key";
var deviceID = "my device id";
var service = new gcm.Sender(apiKey);
var message = new gcm.Message();
message.addData('title', 'Large Icon');
message.addData('message', 'Loaded from assets folder.');
message.addData('image', 'www/image/logo.png');
service.send(message, { registrationTokens: [ deviceID ] }, function (err, response) {
if(err) console.error(err);
else console.log(response);
});Would look for the logo.png file in the assets/www/img folder. Since your apps www folder gets copied into the Android assets folder it is an excellent spot to store the images without needing to write a hook to copy them to the drawables folder. It produces the following notification.
The third is the remote URL. This JSON sent from GCM:
{
"registration_ids": ["my device id"],
"data": {
"title": "Large Icon",
"message": "Loaded from URL",
"image": "https://dl.dropboxusercontent.com/u/887989/antshot.png"
}
}Here is an example using node-gcm that sends the above JSON:
var gcm = require('node-gcm');
// Replace these with your own values.
var apiKey = "replace with API key";
var deviceID = "my device id";
var service = new gcm.Sender(apiKey);
var message = new gcm.Message();
message.addData('title', 'Large Icon');
message.addData('message', 'Loaded from URL');
message.addData('image', 'https://dl.dropboxusercontent.com/u/887989/antshot.png');
service.send(message, { registrationTokens: [ deviceID ] }, function (err, response) {
if(err) console.error(err);
else console.log(response);
});Produces the following notification.
For Android there are three special values for sound you can use. The first is default which will play the phones default notification sound.
{
"registration_ids": ["my device id"],
"data": {
"title": "Default",
"message": "Plays default notification sound",
"soundname": "default"
}
}Then second is ringtone which will play the phones default ringtone sound.
{
"registration_ids": ["my device id"],
"data": {
"title": "Ringtone",
"message": "Plays default ringtone sound",
"soundname": "ringtone"
}
}The third is the empty string which will cause for the playing of sound to be skipped.
{
"registration_ids": ["my device id"],
"data": {
"title": "Silece",
"message": "Skips playing any sound",
"soundname": ""
}
}In order for your your notification to play a custom sound you will need to add the files to your Android project's res/raw directory. Then send the follow JSON from GCM:
{
"registration_ids": ["my device id"],
"data": {
"title": "Sound Test",
"message": "Loaded res/raw",
"soundname": "test"
}
}Here is an example using node-gcm that sends the above JSON:
var gcm = require('node-gcm');
// Replace these with your own values.
var apiKey = "replace with API key";
var deviceID = "my device id";
var service = new gcm.Sender(apiKey);
var message = new gcm.Message();
message.addData('title', 'Sound Test');
message.addData('message', 'Loaded res/raw');
message.addData('soundname', 'test');
service.send(message, { registrationTokens: [ deviceID ] }, function (err, response) {
if(err) console.error(err);
else console.log(response);
});Note: when you specify the custom sound file name omit the file's extension.
By default when using this plugin on Android each notification that your app receives will replace the previous notification in the shade.
If you want to see multiple notifications in the shade you will need to provide a notification ID as part of the push data sent to the app. For instance if you send:
{
"registration_ids": ["my device id"],
"data": {
"title": "Test Push",
"message": "Push number 1"
}
}Here is an example using node-gcm that sends the above JSON:
var gcm = require('node-gcm');
// Replace these with your own values.
var apiKey = "replace with API key";
var deviceID = "my device id";
var service = new gcm.Sender(apiKey);
var message = new gcm.Message();
message.addData('title', 'Test Push');
message.addData('message', 'Push number 1');
service.send(message, { registrationTokens: [ deviceID ] }, function (err, response) {
if(err) console.error(err);
else console.log(response);
});Followed by:
{
"registration_ids": ["my device id"],
"data": {
"title": "Test Push",
"message": "Push number 2"
}
}Here is an example using node-gcm that sends the above JSON:
var gcm = require('node-gcm');
// Replace these with your own values.
var apiKey = "replace with API key";
var deviceID = "my device id";
var service = new gcm.Sender(apiKey);
var message = new gcm.Message();
message.addData('title', 'Test Push');
message.addData('message', 'Push number 2');
service.send(message, { registrationTokens: [ deviceID ] }, function (err, response) {
if(err) console.error(err);
else console.log(response);
});You will only see "Push number 2" in the shade. However, if you send:
{
"registration_ids": ["my device id"],
"data": {
"title": "Test Push",
"message": "Push number 1",
"notId": 1
}
}Here is an example using node-gcm that sends the above JSON:
var gcm = require('node-gcm');
// Replace these with your own values.
var apiKey = "replace with API key";
var deviceID = "my device id";
var service = new gcm.Sender(apiKey);
var message = new gcm.Message();
message.addData('title', 'Test Push');
message.addData('message', 'Push number 1');
message.addData('notId', 1);
service.send(message, { registrationTokens: [ deviceID ] }, function (err, response) {
if(err) console.error(err);
else console.log(response);
});and:
{
"registration_ids": ["my device id"],
"data": {
"title": "Test Push",
"message": "Push number 2",
"notId": 2
}
}Here is an example using node-gcm that sends the above JSON:
var gcm = require('node-gcm');
// Replace these with your own values.
var apiKey = "replace with API key";
var deviceID = "my device id";
var service = new gcm.Sender(apiKey);
var message = new gcm.Message();
message.addData('title', 'Test Push');
message.addData('message', 'Push number 2');
message.addData('notId', 2);
service.send(message, { registrationTokens: [ deviceID ] }, function (err, response) {
if(err) console.error(err);
else console.log(response);
});You will only see both "Push number 1" and "Push number 2" in the shade.
A better alternative to stacking your notifications is to use the inbox style to have up to 8 lines of notification text in a single notification. If you send the following JSON from GCM you will see:
{
"registration_ids": ["my device id"],
"data": {
"title": "My Title",
"message": "My first message",
"style": "inbox",
"summaryText": "There are %n% notifications"
}
}Here is an example using node-gcm that sends the above JSON:
var gcm = require('node-gcm');
// Replace these with your own values.
var apiKey = "replace with API key";
var deviceID = "my device id";
var service = new gcm.Sender(apiKey);
var message = new gcm.Message();
message.addData('title', 'My Title');
message.addData('message', 'My first message');
message.addData('style', 'inbox');
message.addData('summaryText', 'There are %n% notifications');
service.send(message, { registrationTokens: [ deviceID ] }, function (err, response) {
if(err) console.error(err);
else console.log(response);
});It will produce a normal looking notification:
But, if you follow it up with subsequent notifications like:
{
"registration_ids": ["my device id"],
"data": {
"title": "My Title",
"message": "My second message",
"style": "inbox",
"summaryText": "There are %n% notifications"
}
}Here is an example using node-gcm that sends the above JSON:
var gcm = require('node-gcm');
// Replace these with your own values.
var apiKey = "replace with API key";
var deviceID = "my device id";
var service = new gcm.Sender(apiKey);
var message = new gcm.Message();
message.addData('title', 'My Title');
message.addData('message', 'My second message');
message.addData('style', 'inbox');
message.addData('summaryText', 'There are %n% notifications');
service.send(message, { registrationTokens: [ deviceID ] }, function (err, response) {
if(err) console.error(err);
else console.log(response);
});You will get an inbox view so you can display multiple notifications in a single panel.
If you use %n% in the summaryText of the JSON coming down from GCM it will be replaced by the number of messages that are currently in the queue.
Your notification can include action buttons. If you wish to include an icon along with the button name they must be placed in the res/drawable directory of your Android project. Then you can send the following JSON from GCM:
{
"registration_ids": ["my device id"],
"data": {
"title": "AUX Scrum",
"message": "Scrum: Daily touchbase @ 10am Please be on time so we can cover everything on the agenda.",
"actions": [
{ "icon": "emailGuests", "title": "EMAIL GUESTS", "callback": "app.emailGuests", "foreground": true},
{ "icon": "snooze", "title": "SNOOZE", "callback": "app.snooze", "foreground": false}
]
}
}Here is an example using node-gcm that sends the above JSON:
var gcm = require('node-gcm');
// Replace these with your own values.
var apiKey = "replace with API key";
var deviceID = "my device id";
var service = new gcm.Sender(apiKey);
var message = new gcm.Message();
message.addData('title', 'AUX Scrum');
message.addData('message', 'Scrum: Daily touchbase @ 10am Please be on time so we can cover everything on the agenda.');
message.addData('actions', [
{ "icon": "emailGuests", "title": "EMAIL GUESTS", "callback": "app.emailGuests", "foreground": true},
{ "icon": "snooze", "title": "SNOOZE", "callback": "app.snooze", "foreground": false},
]);
service.send(message, { registrationTokens: [ deviceID ] }, function (err, response) {
if(err) console.error(err);
else console.log(response);
});This will produce the following notification in your tray:
If your users clicks on the main body of the notification your app will be opened. However if they click on either of the action buttons the app will open (or start) and the specified JavaScript callback will be executed. In this case it is app.emailGuests and app.snooze respectively. If you set the foreground property to true the app will be brought to the front, if foreground is false then the callback is run without the app being brought to the foreground.
Android N introduces a new capability for push notifications, the in line reply text field. If you wish to get some text data from the user when the action button is called send the following type of payload:
Your notification can include action buttons. If you wish to include an icon along with the button name they must be placed in the res/drawable directory of your Android project. Then you can send the following JSON from GCM:
{
"registration_ids": ["my device id"],
"data": {
"title": "AUX Scrum",
"message": "Scrum: Daily touchbase @ 10am Please be on time so we can cover everything on the agenda.",
"actions": [
{ "icon": "emailGuests", "title": "EMAIL GUESTS", "callback": "app.emailGuests", "foreground": false, "inline": true },
{ "icon": "snooze", "title": "SNOOZE", "callback": "app.snooze", "foreground": false}
]
}
}Here is an example using node-gcm that sends the above JSON:
var gcm = require('node-gcm');
// Replace these with your own values.
var apiKey = "replace with API key";
var deviceID = "my device id";
var service = new gcm.Sender(apiKey);
var message = new gcm.Message();
message.addData('title', 'AUX Scrum');
message.addData('message', 'Scrum: Daily touchbase @ 10am Please be on time so we can cover everything on the agenda.');
message.addData('actions', [
{ "icon": "emailGuests", "title": "EMAIL GUESTS", "callback": "app.emailGuests", "foreground": false, "inline": true},
{ "icon": "snooze", "title": "SNOOZE", "callback": "app.snooze", "foreground": false},
]);
service.send(message, { registrationTokens: [ deviceID ] }, function (err, response) {
if(err) console.error(err);
else console.log(response);
});On Android M and earlier the action buttons will work exactly the same as before but on Android N and greater when the user clicks on the Email Guests button you will see the following:
Then your app's on('notification') event handler will be called without the app being brought to the foreground and the event data would be:
{
"title": "AUX Scrum",
"message": "Scrum: Daily touchbase @ 10am Please be on time so we can cover everything on the agenda.",
"additionalData": {
"inlineReply": "Sounds good",
"actions": [
{
"inline": true,
"callback": "app.accept",
"foreground": false,
"title": "Accept"
},
{
"icon": "snooze",
"callback": "app.reject",
"foreground": false,
"title": "Reject"
}
],
"actionCallback": "app.accept",
"coldstart": false,
"collapse_key": "do_not_collapse",
"foreground": false
}
}
and the text data that the user typed would be located in data.additionalData.inlineReply.
| Attribute | Type | Default | Description |
|---|---|---|---|
icon |
string |
Optional. The name of a drawable resource to use as the small-icon. The name should not include the extension. | |
title |
string |
Required. The label to display for the action button. | |
callback |
string |
Required. The function to be executed when the action button is pressed. The function must be accessible from the global namespace. If you provide myCallback then it amounts to calling window.myCallback. If you provide app.myCallback then there needs to be an object call app, with a function called myCallback accessible from the global namespace, i.e. window.app.myCallback. |
|
foreground |
boolean |
true |
Optional. Whether or not to bring the app to the foreground when the action button is pressed. |
inline |
boolean |
false |
Optional. Whether or not to provide a quick reply text field to the user when the button is clicked. |
You can use a Led notifcation and choose the color of it. Just add a ledColor field in your notification in the ARGB format array:
{
"registration_ids": ["my device id"],
"data": {
"title": "Green LED",
"message": "This is my message with a Green LED",
"ledColor": [0, 0, 255, 0]
}
}Here is an example using node-gcm that sends the above JSON:
var gcm = require('node-gcm');
// Replace these with your own values.
var apiKey = "replace with API key";
var deviceID = "my device id";
var service = new gcm.Sender(apiKey);
var message = new gcm.Message();
message.addData('title', 'Green LED');
message.addData('message', 'This is my message with a Green LED');
message.addData('ledColor', [0, 0, 255, 0]);
service.send(message, { registrationTokens: [ deviceID ] }, function (err, response) {
if(err) console.error(err);
else console.log(response);
});You can set a Vibration Pattern for your notifications. Just add a vibrationPattern field in your notification:
{
"registration_ids": ["my device id"],
"data": {
"title": "Vibration Pattern",
"message": "Device should wait for 2 seconds, vibrate for 1 second then be silent for 500 ms then vibrate for 500 ms",
"vibrationPattern": [2000, 1000, 500, 500]
}
}Here is an example using node-gcm that sends the above JSON:
var gcm = require('node-gcm');
// Replace these with your own values.
var apiKey = "replace with API key";
var deviceID = "my device id";
var service = new gcm.Sender(apiKey);
var message = new gcm.Message();
message.addData('title', 'Vibration Pattern');
message.addData('message', 'Device should wait for 2 seconds, vibrate for 1 second then be silent for 500 ms then vibrate for 500 ms');
message.addData('vibrationPattern', [2000, 1000, 500, 500]);
service.send(message, { registrationTokens: [ deviceID ] }, function (err, response) {
if(err) console.error(err);
else console.log(response);
});You can set a priority parameter for your notifications. Just add a priority field in your notification. -2: minimum, -1: low, 0: default , 1: high, 2: maximum priority:
{
"registration_ids": ["my device id"],
"data": {
"title": "This is a maximum priority Notification",
"message": "This notification should appear in front of all others",
"priority": 2
}
}Here is an example using node-gcm that sends the above JSON:
var gcm = require('node-gcm');
// Replace these with your own values.
var apiKey = "replace with API key";
var deviceID = "my device id";
var service = new gcm.Sender(apiKey);
var message = new gcm.Message();
message.addData('title', 'This is a maximum priority Notification');
message.addData('message', 'This notification should appear in front of all others');
message.addData('priority', 2);
service.send(message, { registrationTokens: [ deviceID ] }, function (err, response) {
if(err) console.error(err);
else console.log(response);
});Perhaps you want to include a large picture in the notification that you are sending to your users. Luckily you can do that too by sending the following JSON from GCM.
{
"registration_ids": ["my device id"],
"data": {
"title": "Big Picture",
"message": "This is my big picture message",
"style": "picture",
"picture": "http://36.media.tumblr.com/c066cc2238103856c9ac506faa6f3bc2/tumblr_nmstmqtuo81tssmyno1_1280.jpg",
"summaryText": "The internet is built on cat pictures"
}
}Here is an example using node-gcm that sends the above JSON:
var gcm = require('node-gcm');
// Replace these with your own values.
var apiKey = "replace with API key";
var deviceID = "my device id";
var service = new gcm.Sender(apiKey);
var message = new gcm.Message();
message.addData('title', 'Big Picture');
message.addData('message', 'This is my big picture message');
message.addData('style', 'picture');
message.addData('picture', 'http://36.media.tumblr.com/c066cc2238103856c9ac506faa6f3bc2/tumblr_nmstmqtuo81tssmyno1_1280.jpg');
message.addData('summaryText', 'The internet is built on cat pictures');
service.send(message, { registrationTokens: [ deviceID ] }, function (err, response) {
if(err) console.error(err);
else console.log(response);
});This will produce the following notification in your tray:
Note: When the notification arrives you will see the title and message like normally. You will only see the picture when the notification is expanded. Once expanded not only will you see the picture but the message portion will disappear and you'll see the summary text portion.
On Android if you want your on('notification') event handler to be called when your app is in the background it is relatively simple.
First the JSON you send from GCM will need to include "content-available": "1". This will tell the push plugin to call your on('notification') event handler no matter what other data is in the push notification.
{
"registration_ids": ["my device id"],
"data": {
"title": "Test Push",
"message": "Push number 1",
"info": "super secret info",
"content-available": "1"
}
}Here is an example using node-gcm that sends the above JSON:
var gcm = require('node-gcm');
// Replace these with your own values.
var apiKey = "replace with API key";
var deviceID = "my device id";
var service = new gcm.Sender(apiKey);
var message = new gcm.Message();
message.addData('title', 'Test Push');
message.addData('message', 'Push number 1');
message.addData('info', 'super secret info');
message.addData('content-available', '1');
service.send(message, { registrationTokens: [ deviceID ] }, function (err, response) {
if(err) console.error(err);
else console.log(response);
});or if you want the payload to be delivered directly to your app without anything showing up in the notification center omit the tite/message from the payload like so:
{
"registration_ids": ["my device id"],
"data": {
"info": "super secret info",
"content-available": "1"
}
}Here is an example using node-gcm that sends the above JSON:
var gcm = require('node-gcm');
// Replace these with your own values.
var apiKey = "replace with API key";
var deviceID = "my device id";
var service = new gcm.Sender(apiKey);
var message = new gcm.Message();
message.addData('info', 'super secret info');
message.addData('content-available', '1');
service.send(message, { registrationTokens: [ deviceID ] }, function (err, response) {
if(err) console.error(err);
else console.log(response);
});If do not want this type of behaviour just omit "content-available": 1 from your push data and your on('notification') event handler will not be called.
The GCM docs will tell you to send a data payload of:
{
"registration_ids": ["my device id"],
"content_available": true,
"data": {
"title": "Test Push",
"message": "Push number 1",
"info": "super secret info",
}
}Where the content-available property is part of the main payload object. Setting the property in this part of the payload will result in the PushPlugin not getting the data correctly. Setting content-available: true will cause the Android OS to handle the push payload for you and not pass the data to the PushPlugin.
Instead move content-available: true into the data object of the payload and set it to 1 as per the example below:
{
"registration_ids": ["my device id"],
"data": {
"title": "Test Push",
"message": "Push number 1",
"info": "super secret info",
"content-available": "1"
}
}These phones have a particular quirk that when the app is force closed that you will no longer be able to receive notifications until the app is restarted. In order for you to receive background notifications:
- On your Huawei device go to Settings > Protected apps > check "My App" where.
- On your Xiaomi makes sure your phone has the "Auto-start" property enabled for your app.
You can set a visibility parameter for your notifications. Just add a visibility field in your notification. -1: secret, 0: private (default), 1: public. Secret shows only the most minimal information, excluding even the notification's icon. Private shows basic information about the existence of this notification, including its icon and the name of the app that posted it. The rest of the notification's details are not displayed. Public Shows the notification's full content.
{
"registration_ids": ["my device id"],
"data": {
"title": "This is a maximum public Notification",
"message": "This notification should appear in front of all others",
"visibility": 1
}
}Here is an example using node-gcm that sends the above JSON:
var gcm = require('node-gcm');
// Replace these with your own values.
var apiKey = "replace with API key";
var deviceID = "my device id";
var service = new gcm.Sender(apiKey);
var message = new gcm.Message();
message.addData('title', 'This is a public Notification');
message.addData('message', 'You should be able to read this notification on your lock screen');
message.addData('visibility', 1);
service.send(message, { registrationTokens: [ deviceID ] }, function (err, response) {
if(err) console.error(err);
else console.log(response);
});On Android not all launchers support badges. In order for us to set badges we use ShortcutBadger in order to set the badge. Check out their website to see which launchers are supported.
In order to set the badge number you will need to include the badge property in your push payload as below:
{
"registration_ids": ["my device id"],
"data": {
"title": "Badge Test",
"message": "Badges, we don't need no stinking badges",
"badge": 7
}
}Here is an example using node-gcm that sends the above JSON:
var gcm = require('node-gcm');
// Replace these with your own values.
var apiKey = "replace with API key";
var deviceID = "my device id";
var service = new gcm.Sender(apiKey);
var message = new gcm.Message();
message.addData('title', 'Badge Test');
message.addData('message', 'Badges, we don\'t need no stinking badges');
message.addData('badge', 7);
service.send(message, { registrationTokens: [ deviceID ] }, function (err, response) {
if(err) console.error(err);
else console.log(response);
});In order for your notification to play a custom sound you will need to add the files to root of your iOS project. The files must be in the proper format. See the Local and Remote Notification Programming Guide for more info on proper file formats and how to convert existing sound files.
Then send the follow JSON from APNS:
{
"aps": {
"alert": "Test sound",
"sound": "sub.caf"
}
}If you want the default sound to play upon receipt of push use this payload:
{
"aps": {
"alert": "Test sound",
"sound": "default"
}
}
On iOS if you want your on('notification') event handler to be called when your app is in the background you will need to do a few things.
First the JSON you send from APNS will need to include "content-available": 1 to the aps object. The "content-available": 1 property in your push message is a signal to iOS to wake up your app and give it up to 30 seconds of background processing. If do not want this type of behaviour just omit "content-available": 1 from your push data.
For instance the following JSON:
{
"aps": {
"alert": "Test background push",
"content-available": 1
}
}will produce a notification in the notification shade and call your on('notification') event handler.
However if you want your on('notification') event handler called but no notification to be shown in the shader you would omit the alert property and send the following JSON to APNS:
{
"aps": {
"data": "Test silent background push",
"moredata": "Do more stuff",
"content-available": 1
}
}That covers what you need to do on the server side to accept background pushes on iOS. However, it is critically important that you continue reading as there will be a change in your on('notification'). When you receive a background push on iOS you will be given 30 seconds of time in which to complete a task. If you spend longer than 30 seconds on the task the OS may decide that your app is misbehaving and kill it. In order to signal iOS that your on('notification') handler is done you will need to call the new push.finish() method.
For example:
var push = PushNotification.init({
"ios": {
"sound": "true",
"alert": "true",
"badge": "true",
"clearBadge": "true"
}
});
push.on('registration', function(data) {
// send data.registrationId to push service
});
push.on('notification', function(data) {
// do something with the push data
// then call finish to let the OS know we are done
push.finish(function() {
console.log("processing of push data is finished");
});
});It is absolutely critical that you call push.finish() when you have successfully processed your background push data.
Your notification can include action buttons. For iOS 8+ you must setup the possible actions when you initialize the plugin:
var push = PushNotification.init({
"ios": {
"sound": true,
"alert": true,
"badge": true,
"categories": {
"invite": {
"yes": {
"callback": "app.accept", "title": "Accept", "foreground": true, "destructive": false
},
"no": {
"callback": "app.reject", "title": "Reject", "foreground": true, "destructive": false
},
"maybe": {
"callback": "app.maybe", "title": "Maybe", "foreground": true, "destructive": false
}
},
"delete": {
"yes": {
"callback": "app.doDelete", "title": "Delete", "foreground": true, "destructive": true
},
"no": {
"callback": "app.cancel", "title": "Cancel", "foreground": true, "destructive": false
}
}
}
}
});You’ll notice that we’ve added a new parameter to the iOS object of our init code called categories. Each category is a named object, invite and delete in this case. These names will need to match the one you send via your payload to APNS if you want the action buttons to be displayed. Each category can have up to three buttons which must be labeled yes, no and maybe. In turn each of these buttons has four properties, callback the javascript function you want to call, title the label for the button, foreground whether or not to bring your app to the foreground and destructive which doesn’t actually do anything destructive it just colors the button red as a warning to the user that the action may be destructive.
Just like with background notifications it is absolutely critical that you call push.finish() when you have successfully processed the button callback. For instance:
app.accept = function(data) {
// do something with the notification data
push.finish(function() {
console.log('accept callback finished');
}, function() {
console.log('accept callback failed');
}, data.additionalData.notId);
};You may notice that the finish method now takes success, failure and id parameters. The id parameter let's the operating system know which background process to stop. You'll set it in the next step.
Then you will need to set the category value in your aps payload to match one of the objects in the categories object. As well you should set a notId property in the root of payload object. This is the parameter you pass to the finish method in order to tell the operating system that the processing of the push event is done.
{
"aps": {
"alert": "This is a notification that will be displayed ASAP.",
"category": "invite"
},
"notId": "1"
}This will produce the following notification in your tray:
If your users clicks on the main body of the notification your app will be opened. However if they click on either of the action buttons the app will open (or start) and the specified JavaScript callback will be executed.
If you are using GCM to send push messages on iOS you will need to send a different payload in order for the action buttons to be present in the notification shade. You'll need to use the click-action property in order to specify the category.
{
"registration_ids": ["my device id"],
"notification": {
"title": "AUX Scrum",
"body": "Scrum: Daily touchbase @ 10am Please be on time so we can cover everything on the agenda.",
"click-action": "invite"
}
}The plugin supports all types of windows platform notifications namely Tile, Toast, Badge and Raw. The API supports the basic cases of the notification templates with title corresponding to the first text element and message corresponding to the second if title is present else the first one. The image corresponds to the first image element of the notification xml.
The count is present only for the badge notification in which it represent the value of the notification which could be a number from 0-99 or a status glyph.
For advanced templates and usage, the notification object is included in data.additionalData.pushNotificationReceivedEventArgs.
This plugin automatically sets the toast capable flag to be true for Cordova 5.1.1+. For lower versions, you must declare that it is Toast Capable in your app's manifest file.
The default handling can be disabled by setting the 'cancel' property in the notification object.
data.additionalData.pushNotificationReceivedEventArgs.cancel = trueOn Windows, to trigger the on('notification') event handler when your app is in the background and it is launched through the push notification, you will have to include activation data in the payload of the notification. This is done by using the launch attribute, which can be any string that can be understood by the app. However it should not cause the XML payload to become invalid.
If you do not include a launch attribute string, your app will be launched normally, as though the user had launched it from the Start screen, and the notification event handler won't be called.
Here is an example of a sample toast notification payload containing the launch attribute:
<toast launch="{"myContext":"12345"}">
<visual>
<binding template="ToastImageAndText01">
<image id="1" src="ms-appx:///images/redWide.png" alt="red graphic"/>
<text id="1">Hello World!</text>
</binding>
</visual>
</toast>This launch attribute string is passed on to the app as data.launchArgs through the on('notification') handler. It's important to note that due to the Windows platform design, the other visual payload is not available to the handler on cold start. So notification attributes like message, title etc. which are available through the on('notification') handler when the app is running, won't be available for background notifications.