This plugin is for use with Cordova, and allows your application to receive push notifications on Amazon Fire OS, Android, iOS and WP8 devices. The Amazon Fire OS implementation uses Amazon's ADM(Amazon Device Messaging) service, the Android implementation uses Google's GCM (Google Cloud Messaging) service, whereas the iOS version is based on Apple APNS Notifications. The WP8 implementation is based on MPNS.
Important - Push notifications are intended for real devices. They are not tested for WP8 Emulator. The registration process will fail on the iOS simulator. Notifications can be made to work on the Android Emulator. However, doing so requires installation of some helper libraries, as outlined here, under the section titled "Installing helper libraries and setting up the Emulator".
The MIT License
Copyright (c) 2012 Adobe Systems, inc.
portions Copyright (c) 2012 Olivier Louvignes
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.
-
Copy the contents of src/amazon/com/ to your project's src/com/ folder.
-
Modify your AndroidManifest.xml and add the following lines to your manifest tag:
<permission android:name="$PACKAGE_NAME.permission.RECEIVE_ADM_MESSAGE" android:protectionLevel="signature" />
<uses-permission android:name="$PACKAGE_NAME.permission.RECEIVE_ADM_MESSAGE" />
<uses-permission android:name="com.amazon.device.messaging.permission.RECEIVE" />
<uses-permission android:name="android.permission.WAKE_LOCK" />- Modify your AndroidManifest.xml and add the following activity, receiver and service tags to your application section.
<amazon:enable-feature android:name="com.amazon.device.messaging" android:required="true"/>
<service android:exported="false" android:name="com.amazon.cordova.plugin.ADMMessageHandler" />
<activity android:name="com.amazon.cordova.plugin.ADMHandlerActivity" />
<receiver android:name="com.amazon.cordova.plugin.ADMMessageHandler$Receiver" android:permission="com.amazon.device.messaging.permission.SEND">
<intent-filter>
<action android:name="com.amazon.device.messaging.intent.REGISTRATION" />
<action android:name="com.amazon.device.messaging.intent.RECEIVE" />
<category android:name="$PACKAGE_NAME" />
</intent-filter>
</receiver> - Modify your AndroidManifest.xml and add "amazon" XML namespace to tag:
xmlns:amazon="http://schemas.amazon.com/apk/res/android"- Modify your res/xml/config.xml to add a reference to PushPlugin:
<feature name="PushPlugin" >
<param name="android-package" value="com.amazon.cordova.plugin.PushPlugin"/>
</feature>- Modify your res/xml/config.xml to set some config options to let Cordova know whether to display ADM message in the notification center or not. If not, provide the default message. By default, message will be visible in the notification. These config options are used if message arrives and app is not in the foreground(either Killed or running in the background).
<preference name="showmessageinnotification" value="true" />
<preference name="defaultnotificationmessage" value="New message has arrived!" />- Finally, put api_key.txt (given to you when you register your app on Amazon Developer Portal. For detailed steps on how to register for ADM please refer to section "Registering your app for Amazon Device Messaging(ADM)"
-
copy the contents of src/android/com/ to your project's src/com/ folder. copy the contents of libs/ to your libs/ folder. copy {android_sdk_path}/extras/android/support/v13/android-support-v13.jar to your libs/ folder. The final hierarchy will likely look something like this:
{project_folder} libs gcm.jar android-support-v13.jar cordova-3.4.0.jar src com plugin gcm CordovaGCMBroadcastReceiver.java GCMIntentService.java PushHandlerActivity.java PushPlugin.java {company_name} {intent_name} {intent_name}.java
-
Modify your AndroidManifest.xml and add the following lines to your manifest tag:
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.GET_ACCOUNTS" />
<uses-permission android:name="android.permission.WAKE_LOCK" />
<uses-permission android:name="com.google.android.c2dm.permission.RECEIVE" />
<permission android:name="$PACKAGE_NAME.permission.C2D_MESSAGE" android:protectionLevel="signature" />
<uses-permission android:name="$PACKAGE_NAME.permission.C2D_MESSAGE" />- Modify your AndroidManifest.xml and add the following activity, receiver and service tags to your application section. (See the Sample_AndroidManifest.xml file in the Example folder.)
<activity android:name="com.plugin.gcm.PushHandlerActivity"/>
<receiver android:name="com.plugin.gcm.CordovaGCMBroadcastReceiver" android:permission="com.google.android.c2dm.permission.SEND" >
<intent-filter>
<action android:name="com.google.android.c2dm.intent.RECEIVE" />
<action android:name="com.google.android.c2dm.intent.REGISTRATION" />
<category android:name="$PACKAGE_NAME" />
</intent-filter>
</receiver>
<service android:name="com.plugin.gcm.GCMIntentService" />- Modify your res/xml/config.xml to include the following line in order to tell Cordova to include this plugin and where it can be found: (See the Sample_config.xml file in the Example folder)
<feature name="PushPlugin">
<param name="android-package" value="com.plugin.gcm.PushPlugin" />
</feature>- Add the PushNotification.js script to your assets/www folder (or javascripts folder, wherever you want really) and reference it in your main index.html file. This file's usage is described in the Plugin API section below.
<script type="text/javascript" charset="utf-8" src="PushNotification.js"></script>Copy the following files to your project's Plugins folder:
AppDelegate+notification.h
AppDelegate+notification.m
PushPlugin.h
PushPlugin.m
Add a reference for this plugin to the plugins section in config.xml:
<feature name="PushPlugin">
<param name="ios-package" value="PushPlugin" />
</feature>Add the PushNotification.js script to your assets/www folder (or javascripts folder, wherever you want really) and reference it in your main index.html file.
<script type="text/javascript" charset="utf-8" src="PushNotification.js"></script>Copy the following files to your project's Commands folder and add it to the VS project:
PushPlugin.cs
Add a reference to this plugin in config.xml:
<feature name="PushPlugin">
<param name="wp-package" value="PushPlugin" />
</feature>Add the PushNotification.js script to your assets/www folder (or javascripts folder, wherever you want really) and reference it in your main index.html file.
<script type="text/javascript" charset="utf-8" src="PushNotification.js"></script>Do not forget to reference the cordova.js as well.
<script type="text/javascript" charset="utf-8" src="cordova.js"></script>In your Visual Studio project add reference to the Newtonsoft.Json.dll as well - it is needed for serialization and deserialization of the objects.
Also you need to enable the "ID_CAP_PUSH_NOTIFICATION" capability in Properties->WMAppManifest.xml of your project.
This plugin is based on plugman. to install it to your app, simply execute plugman as follows;
plugman install --platform [PLATFORM] --project [TARGET-PATH] --plugin [PLUGIN-PATH]
where
[PLATFORM] = ios, android or wp8
[TARGET-PATH] = path to folder containing your phonegap project
[PLUGIN-PATH] = path to folder containing this pluginAlternatively this plugin can be installed using the Phonegap CLI:
- Navigate to the root folder for your phonegap project.
- Run the command.
phonegap local plugin add https://github.com/phonegap-build/PushPlugin.gitor the Cordova CLI:
cordova plugin add https://github.com/phonegap-build/PushPlugin.git
For additional info, take a look at the Plugman Documentation and Cordova Plugin Specification
Note: For Amazon Fire OS, you will have to follow 2 steps below after automatic installation:
- Modify your AndroidManifest.xml and add "amazon" XML namespace to tag:
xmlns:amazon="http://schemas.amazon.com/apk/res/android"- Put api_key.txt (given to you when you register your app on Amazon Developer Portal in your app's assets folder ($path to app/platforms/amazon-fireos/assets/). For detailed steps on how to register for ADM please refer to section "Registering your app for Amazon Device Messaging(ADM)"
In the Examples folder you will find a sample implementation showing how to interact with the PushPlugin. Modify it to suit your needs.
First create the plugin instance variable.
var pushNotification;When deviceReady fires, get the plugin reference
pushNotification = window.plugins.pushNotification;This should be called as soon as the device becomes ready. On success, you will get a call to tokenHandler (iOS), or onNotificationGCM (Amazon Fire OS and Android), or onNotificationWP8 (WP8), allowing you to obtain the device token or registration ID, or push channel name and Uri respectively. Those values will typically get posted to your intermediary push server so it knows who it can send notifications to.
For Amazon Fire OS, if you have not already registered with Amazon developer portal,you will have to obtain credentials and api_key for your app. This is described more in detail in the Registering your app for Amazon Device Messaging(ADM) section below.
For Android, If you have not already done so, you'll need to set up a Google API project, to generate your senderID. Follow these steps to do so. This is described more fully in the Test Environment section below.
In this example, be sure and substitute your own senderID. Get your senderID by signing into to your google dashboard. The senderID is found at Overview->Dashboard->Project Number.
Note: For Amazon Fire OS platform, sender_id is not needed. If you provide one, it will be ignored. "ecb" MUST be provided in order to get callback notifications.
if ( device.platform == 'android' || device.platform == 'Android' || device.platform == "Amazon" || device.platform == "amazon")
{
pushNotification.register(
successHandler,
errorHandler, {
"senderID":"replace_with_sender_id",
"ecb":"onNotificationGCM"
});
}
else
{
pushNotification.register(
tokenHandler,
errorHandler, {
"badge":"true",
"sound":"true",
"alert":"true",
"ecb":"onNotificationAPN"
});
}successHandler - called when a plugin method returns without error
// result contains any message sent from the plugin call
function successHandler (result) {
alert('result = ' + result);
}errorHandler - called when the plugin returns an error
// result contains any error description text returned from the plugin call
function errorHandler (error) {
alert('error = ' + error);
}tokenHandler (iOS only) - called when the device has registered with a unique device token.
function tokenHandler (result) {
// Your iOS push server needs to know the token before it can push to this device
// here is where you might want to send it the token for later use.
alert('device token = ' + result);
}senderID (Android only) - This is the Google project ID you need to obtain by registering your application for GCM
ecb - event callback that gets called when your device receives a notification
// iOS
function onNotificationAPN (event) {
if ( event.alert )
{
navigator.notification.alert(event.alert);
}
if ( event.sound )
{
var snd = new Media(event.sound);
snd.play();
}
if ( event.badge )
{
pushNotification.setApplicationIconBadgeNumber(successHandler, errorHandler, event.badge);
}
}
// Android
function onNotificationGCM(e) {
$("#app-status-ul").append('<li>EVENT -> RECEIVED:' + e.event + '</li>');
switch( e.event )
{
case 'registered':
if ( e.regid.length > 0 )
{
$("#app-status-ul").append('<li>REGISTERED -> REGID:' + e.regid + "</li>");
// Your GCM push server needs to know the regID before it can push to this device
// here is where you might want to send it the regID for later use.
console.log("regID = " + e.regid);
}
break;
case 'message':
// if this flag is set, this notification happened while we were in the foreground.
// you might want to play a sound to get the user's attention, throw up a dialog, etc.
if ( e.foreground )
{
$("#app-status-ul").append('<li>--INLINE NOTIFICATION--' + '</li>');
// if the notification contains a soundname, play it.
var my_media = new Media("/android_asset/www/"+e.soundname);
my_media.play();
}
else
{ // otherwise we were launched because the user touched a notification in the notification tray.
if ( e.coldstart )
{
$("#app-status-ul").append('<li>--COLDSTART NOTIFICATION--' + '</li>');
}
else
{
$("#app-status-ul").append('<li>--BACKGROUND NOTIFICATION--' + '</li>');
}
}
$("#app-status-ul").append('<li>MESSAGE -> MSG: ' + e.payload.message + '</li>');
//Only works for GCM
$("#app-status-ul").append('<li>MESSAGE -> MSGCNT: ' + e.payload.msgcnt + '</li>');
//Only works on Amazon Fire OS
$status.append('<li>MESSAGE -> TIME: ' + e.payload.timeStamp + '</li>');
break;
case 'error':
$("#app-status-ul").append('<li>ERROR -> MSG:' + e.msg + '</li>');
break;
default:
$("#app-status-ul").append('<li>EVENT -> Unknown, an event was received and we do not know what it is</li>');
break;
}
}Looking at the above message handling code for Android/Amazon Fire OS, a few things bear explanation. Your app may receive a notification while it is active (INLINE). If you background the app by hitting the Home button on your device, you may later receive a status bar notification. Selecting that notification from the status will bring your app to the front and allow you to process the notification (BACKGROUND). Finally, should you completely exit the app by hitting the back button from the home page, you may still receive a notification. Touching that notification in the notification tray will relaunch your app and allow you to process the notification (COLDSTART). In this case the coldstart flag will be set on the incoming event. You can look at the foreground flag on the event to determine whether you are processing a background or an in-line notification. You may choose, for example to play a sound or show a dialog only for inline or coldstart notifications since the user has already been alerted via the status bar.
For Amazon Fire OS platform, offline message can also be received when app is launched via carousel or by tapping on app icon from apps. In either case once app delivers the offline message to JS, notification will be cleared.
Also make note of the payload object. Since the Android notification data model is much more flexible than that of iOS, there may be additional elements beyond message, soundname, and msgcnt. You can access those elements and any additional ones via the payload element. This means that if your data model should change in the future, there will be no need to change and recompile the plugin.
channelHandler (WP8 only) - Called after a push notification channel is opened and push notification URI is returned. The application is now set to receive notifications.
Register as
pushNotification = window.plugins.pushNotification;
pushNotification.register(channelHandler, errorHandler, { "channelName": channelName, "ecb": "onNotificationWP8", "uccb": "channelHandler", "errcb": "jsonErrorHandler" });
function successHandler(result) {
console.log('registered###' + result.uri);
// send uri to your notification server
}onNotificationWP8 is fired if the app is running when you receive the toast notification, or raw notification.
//handle MPNS notifications for WP8
function onNotificationWP8(e) {
if (e.type == "toast" && e.jsonContent) {
pushNotification.showToastNotification(successHandler, errorHandler,
{
"Title": e.jsonContent["wp:Text1"], "Subtitle": e.jsonContent["wp:Text2"], "NavigationUri": e.jsonContent["wp:Param"]
});
}
if (e.type == "raw" && e.jsonContent) {
alert(e.jsonContent.Body);
}
}uccb - event callback that gets called when the channel you have opened gets its Uri updated. This function is needed in case the MPNS updates the opened channel Uri. This function will take care of showing updated Uri.
errcb - event callback that gets called when server error occurs when receiving notification from the MPNS server. jsonErrorHandler is fired by the plugin if server error occurs while receiving notification (for example invalid format of the notification)
function jsonErrorHandler(error) {
$("#app-status-ul").append('<li style="color:red;">error:' + error.code + '</li>');
$("#app-status-ul").append('<li style="color:red;">error:' + error.message + '</li>');
}
To control the launch page when the user taps on your toast notification when the app is not running, add the following code to your mainpage.xaml.cs
protected override void OnNavigatedTo(System.Windows.Navigation.NavigationEventArgs e)
{
base.OnNavigatedTo(e);
try
{
if (this.NavigationContext.QueryString["NavigatedFrom"] == "toast") // this is set on the server
{
this.PGView.StartPageUri = new Uri("//www/index.html#notification-page", UriKind.Relative);
}
}
catch (KeyNotFoundException)
{
}
}
Or you can add another Page2.xaml just for testing toast navigate url. Like the MSDN Toast Sample
To test the tile notification, you will need to add tile images like the MSDN Tile Sample
You will typically call this when your app is exiting, to cleanup any used resources. Its not strictly necessary to call it, and indeed it may be desireable to NOT call it if you are debugging your intermediarry push server. When you call unregister(), the current token for a particular device will get invalidated, and the next call to register() will return a new token. If you do NOT call unregister(), the last token will remain in effect until it is invalidated for some reason at the GCM side. Since such invalidations are beyond your control, its recommended that, in a production environment, that you have a matching unregister() call, for every call to register(), and that your server updates the devices' records each time.
pushNotification.unregister(successHandler, errorHandler, options);For Android and iOS you may emit the options as they are not used by the plugin.
When using the plugin for wp8 you will need to unregister the push channel you have register in case you would want to open another one. You need to know the name of the channel you have opened in order to close it. Please keep in mind that one application can have only one opened channel at time and in order to open another you will have to close any already opened channel.
function unregister() {
var channelName = $("#channel-btn").val();
pushNotification.unregister(
successHandler, errorHandler,
{
"channelName": channelName
});
}
You'll probably want to trap on the backbutton event and only call this when the home page is showing. Remember, the back button on android is not the same as the Home button. When you hit the back button from the home page, your activity gets dismissed. Here is an example of how to trap the backbutton event;
function onDeviceReady() {
$("#app-status-ul").append('<li>deviceready event received</li>');
document.addEventListener("backbutton", function(e)
{
$("#app-status-ul").append('<li>backbutton event received</li>');
if( $("#home").length > 0 )
{
e.preventDefault();
pushNotification.unregister(successHandler, errorHandler);
navigator.app.exitApp();
}
else
{
navigator.app.backHistory();
}
}, false);
// additional onDeviceReady work...
}For the above to work, make sure the content for your home page is wrapped in an element with an id of home, like this;
<div id="home">
<div id="app-status-div">
<ul id="app-status-ul">
<li>Cordova PushNotification Plugin Demo</li>
</ul>
</div>
</div>set the badge count visible when the app is not running
pushNotification.setApplicationIconBadgeNumber(successCallback, errorCallback, badgeCount);badgeCount - an integer indicating what number should show up in the badge. Passing 0 will clear the badge.
Show toast notification if app is deactivated. The toast notification's properties are set explicitly using json. They can be get in onNotificationWP8 and used for whatever purposes needed.
pushNotification.showToastNotification(successCallback, errorCallback, options);
The notification system consists of several interdependent components.
1) The client application which runs on a device and receives notifications.
2) The notification service provider (ADM for Amazon Fire OS, APNS for Apple, GCM for Google)
3) Intermediary servers that collect device IDs from clients and push notifications through Amazon ADM servers, APNS and/or GCM.
This plugin and its target Cordova application comprise the client application.The ADM, APNS and GCM infrastructure are maintained by Amazon, Apple and Google, respectively. In order to send push notifications to your users, you would typically run an intermediary server or employ a 3rd party push service. This is true for all ADM(Amazon), GCM (Android) and APNS (iOS) notifications. However, when testing the notification client applications, it may be desirable to be able to push notifications directly from your desktop, without having to design and build those server's first. There are a number of solutions out there to allow you to push from a desktop machine, sans server. The easiest I've found to work with is a ruby gem called pushmeup. I've only tried this on Mac, but it probably works fine on Windows as well. Here's a rough outline;
Prerequisites.
-
Ruby gems is installed and working.
-
You have successfully built a client with this plugin, on both iOS and Android and have installed them on a device.
1) Get the gem
$ sudo gem install pushmeup
2) (iOS) Follow this tutorial to create a file called ck.pem.
Start at the section entitled "Generating the Certificate Signing Request (CSR)", and substitute your own Bundle Identifier, and Description.
a) go the this plugin's Example/server folder and open pushAPNS.rb in the text editor of your choice.
b) set the APNS.pem variable to the path of the ck.pem file you just created
c) set APNS.pass to the password associated with the certificate you just created. (warning this is cleartext, so don't share this file)
d) set device_token to the token for the device you want to send a push to. (you can run the Cordova app / plugin in Xcode and extract the token from the log messages)
e) save your changes.
3) (Android) Follow these steps to generate a project ID and a server based API key.
a) go the this plugin's Example/server folder and open pushGCM.rb in the text editor of your choice.
b) set the GCM.key variable to the API key you just generated.
c) set the destination variable to the Registration ID of the device. (you can run the Cordova app / plugin in on a device via Eclipse and extract the regID from the log messages)
a) cd to the directory containing the two .rb files we just edited.
b) Run the Cordova app / plugin on both the Android and iOS devices you used to obtain the regID / device token, respectively.
c) $ ruby pushGCM.rb
d) $ ruby pushAPNS.rb
Server for ADM
There is a python script that runs a simple web server from your local machine. Goto Example/Server folder. Follow the steps below:
1) open ADMServer.py in text editor and change the PORT, PROD_CLIENT_ID and PROD_CLIENT_SECRET values.
3) Open your favorite browser and load server url : http://localhost:4000/. It should report "Server Running". If you don't see this then check on command line for any errors. This also means something went wrong with ADM registration. Double check your Client_ID and Secret_Code. Also, make sure your app on Amazon dev portal has Device Messaging switch turned ON.
4) Once you register through the app and have valid registrationId, you should register that with the server too using this url: http://localhost:4000/register?device=registraionId.
5) To see list of registered devices with your server use this url: http://localhost:4000/show-devices
6) To send a message to one or more registered devices use this url: http://localhost:4000/show-devices, click on the radio button next to device id and type in the message.
If all went well, you should see a notification show up on each device. If not, make sure you are not being blocked by a firewall, and that you have internet access. Check and recheck the token id, the registration ID and the certificate generating process.
In a production environment, your app, upon registration, would send the device id (iOS) or the registration id (Android), to your intermediary push server. For iOS, the push certificate would also be stored there, and would be used to authenticate push requests to the APNS server. When a push request is processed, this information is then used to target specific apps running on individual devices.
If you're not up to building and maintaining your own intermediary push server, there are a number of commercial push services out there which support both APNS and GCM.
kony and many others.
Amazon Simple Notification Service
The simplest way to test the plugin is to create an ASP.NET webpage that sends different notifications by using the URI that is returned when the push channel is created on the device.
You can see how to create one from MSDN Samples:
Send Toast Notifications (MSDN Sample)
Send Tile Notification (MSDN Sample)
Send Raw Notification (MSDN Sample)
If you run this demo using the emulator you will not receive notifications from GCM. You need to run it on an actual device to receive messages or install the proper libraries on your emulator (You can follow this guide under the section titled "Installing helper libraries and setting up the Emulator")
If everything seems right and you are not receiving a registration id response back from Google, try uninstalling and reinstalling your app. That has worked for some devs out there.
While the data model for iOS is somewhat fixed, it should be noted that GCM is far more flexible. The Android implementation in this plugin, for example, assumes the incoming message will contain a 'message' and a 'msgcnt' node. This is reflected in both the plugin (see GCMIntentService.java) as well as in provided example ruby script (pushGCM.rb). Should you employ a commercial service, their data model may differ. As mentioned earlier, this is where you will want to take a look at the payload element of the message event. In addition to the cannonical message and msgcnt elements, any additional elements in the incoming JSON object will be accessible here, obviating the need to edit and recompile the plugin. Many thanks to Tobias Hößl for this functionality!
Local and Push Notification Programming Guide (Apple)
Google Cloud Messaging for Android (Android)
Apple Push Notification Services Tutorial: Part 1/2
Apple Push Notification Services Tutorial: Part 2/2
How to Implement Push Notifications for Android
Huge thanks to Mark Nutter whose GCM-Cordova plugin forms the basis for the Android side implimentation.
Likewise, the iOS side was inspired by Olivier Louvignes' Cordova PushNotification Plugin (Copyright (c) 2012 Olivier Louvignes) for iOS.
Props to Tobias Hößl, who provided the code to surface the full JSON object up to the JS layer.