Push notifications for cordova (ios, android) browser (Chrome, Safari, Firefox) - One unified api on client and server.
Status:
- APN iOS
- GCM/FCM Android
- APN Safari web push (partially implemented)
- GCM Chrome OS (partially implemented)
- Firefox OS (partially implemented)
- BPS Blackberry 10
- MPNS Windows phone 8
- MPNS Windows 8
- ADM Amazon Fire OS
- Meteor in app notifications
We are using semantic-release following the AngularJS Commit Message Conventions - Following this pattern will result in better versioning, better changelog and shorter release cycle.
If you are using apn options and upgrading from any lower version. You have to make changes in config of apn. New configs are listed below.
Meteor version should be ≥ 1.8.1
For lower versions of meteor please follow the Four changes you need to do in your project for meteor < 1.8.1 section here.
$ meteor add raix:push
$ meteor add cordova:cordova-plugin-device@1.1.6
$ meteor add cordova:phonegap-plugin-push@2.2.3Depending on the platforms you want to work with you will need some credentials or certificates.
Have a look at the Basic example
Theres a good walkthrough by Arthur Carabott
Read the raix:push Newbie Manual by @harryward
Or check out the DEMO by @elvismercado (This example uses the deprecated config.push.json)
For implementation of Notification Channels, check out the Raix:Push - Support for Android Channels by Shivang Kar
Example code for sound (todo: add in docs)
Note: Some of the documentation is outdated, please file an issue or create a pull request - same if you find a bug or want to add tests
Watch the project progress for status or join development
Use the Push.Configure function on client and server.
For example in Meteor.startup() block of main.js
Push.Configure({
android: {
senderID: 12341234,
alert: true,
badge: true,
sound: true,
vibrate: true,
clearNotifications: true
// icon: '',
// iconColor: ''
},
ios: {
alert: true,
badge: true,
sound: true
}
});Additionally you have to touch mobile-config.js
App.configurePlugin('phonegap-plugin-push', {
SENDER_ID: 12341234
});This is due to changes in the cordova plugin itself
For example in Meteor.startup() block of main.js. Version 4.0.0 and above
Push.Configure({
apn: {
cert: Assets.getText('apnDevCert.pem'),
key: Assets.getText('apnDevKey.pem'),
passphrase: 'xxxxxxxxx',
production: true,
topic: 'com.your.app.identifier' //required
//gateway: 'gateway.push.apple.com',
},
gcm: {
apiKey: 'xxxxxxx', // GCM/FCM server key
}
// production: true,
// 'sound' true,
// 'badge' true,
// 'alert' true,
// 'vibrate' true,
// 'sendInterval': 15000, Configurable interval between sending
// 'sendBatchSize': 1, Configurable number of notifications to send per batch
// 'keepNotifications': false,
//
});For example in Meteor.startup() block of main.js. Version 3.0.2 and below
Push.Configure({
apn: {
certData: Assets.getText('apnDevCert.pem'),
keyData: Assets.getText('apnDevKey.pem'),
passphrase: 'xxxxxxxxx',
production: true,
//gateway: 'gateway.push.apple.com',
},
gcm: {
apiKey: 'xxxxxxx', // GCM/FCM server key
}
// production: true,
// 'sound' true,
// 'badge' true,
// 'alert' true,
// 'vibrate' true,
// 'sendInterval': 15000, Configurable interval between sending
// 'sendBatchSize': 1, Configurable number of notifications to send per batch
// 'keepNotifications': false,
//
});Note: config.push.json is deprecating
// Push.debug = true; // Add verbosity
Push.send({
from: 'push',
title: 'Hello',
text: 'world',
badge: 1, //optional, use it to set badge count of the receiver when the app is in background.
query: {
// Ex. send to a specific user if using accounts:
userId: 'xxxxxxxxx'
} // Query the appCollection
// token: appId or token eg. "{ apn: token }"
// tokens: array of appId's or tokens
// payload: user data
// delayUntil: Date
});When in secure mode the client send features require adding allow/deny rules in order to allow the user to send push messages to other users directly from the client - Read more below
Push.id(); // Unified application id - not a token
Push.setBadge(count); // ios specific - ignored everywhere else
Push.enabled(); // Return true or false
Push.enabled(false); // Will disable notifications
Push.enabled(true); // Will enable notifications (requires a token...)This package allows you to send notifications from the server and client. To restrict the client or allowing the client to send use allow or deny rules.
When a client calls send on Push, the Push's allow and deny callbacks are called on the server to determine if the send should be allowed. If at least one allow callback allows the send, and no deny callbacks deny the send, then the send is allowed to proceed.
Push.allow({
send: function(userId, notification) {
return true; // Allow all users to send
}
});
// Or...
Push.deny({
send: function(userId, notification) {
return false; // Allow all users to send
}
});Stores a token associated with an application and optionally, a userId.
Parameters:
options - An object containing the necessary data to store a token. Fields:
id- String (optional) - a record id for the Application/Token document to update. If this does not exist, will return 404.token- Object -{ apn: 'TOKEN' }or{ gcm: 'TOKEN' }appName- String - the name of the application to associate the token withuserId- String (optional) - the user id so associate with the token and application. If none is included no user will be associated. Useraix:push-setuserto later associate a userId with a token.
Returns:
recordId - The id of the stored document associating appName, token, and optionally user in an object of the form:
{
result: 'recordId'
}
Associates the current users ID with an Application/Token record based on the given id.
Parameters:
id - String - The ID of the Application/Token record
Adds metadata to a particular Application/Token record.
Parameters
data - Object containing the following fields:
id- String - the ID of the Application/Token record to updatemetadata- Object - The metadata object to add to the Application/Token document
For more internal or advanced features read ADVANCED.md
We have a slack channel to keep communication tight between contributors - it's on https://meteoropensourcecomm.slack.com in channel #raixpush
Kind regards
Morten (aka RaiX)