React Native TC Push Notifications
React Native Local and Remote Notifications for iOS and Android. This package is based on React Native Push Notifications Package and make optimization to group Android notification together.
Supported React Native Versions
Component Version | RN Versions |
---|---|
>= 1.1.9 | >= 0.33 |
Installation
npm install react-native-tc-push-notification
Issues
Having a problem? Read the troubleshooting guide before raising an issue.
iOS manual Installation
The component uses PushNotificationIOS for the iOS part.
Please see: PushNotificationIOS
Android manual Installation
NOTE: To use a specific play-service-gcm
version, use in your android/app/build.gradle
(change 8.1.0
for your version):
... dependencies { ... compile project(':react-native-tc-push-notification') compile ('com.google.android.gms:play-services-gcm:8.1.0') { force = true; }}
In your AndroidManifest.xml
..... .....
In android/settings.gradle
... include ':react-native-tc-push-notification'project(':react-native-tc-push-notification').projectDir = file('../node_modules/react-native-tc-push-notification/android')
Manually register module in MainApplication.java
(if you did not use react-native link
):
// <--- Import Package
Usage
var PushNotification = ; PushNotification;
Handling Notifications
When any notification is opened or received the callback onNotification
is called passing an object with the notification data.
Notification object example:
foreground: false // BOOLEAN: If the notification was received in foreground or not userInteraction: false // BOOLEAN: If the notification was opened by the user from the notification area or not message: 'My Notification Message' // STRING: The notification message data: {} // OBJECT: The push data
Local Notifications
PushNotification.localNotification(details: Object)
EXAMPLE:
PushNotification;
Scheduled Notifications
PushNotification.localNotificationSchedule(details: Object)
EXAMPLE:
PushNotification;
Custom sounds
In android, add your custom sound file to [project_root]/android/app/src/main/res/raw
In iOS, add your custom sound file to the project Resources
in xCode.
In the location notification json specify the full file name:
soundName: 'my_sound.mp3'
Cancelling notifications
1) cancelLocalNotifications
PushNotification.cancelLocalNotifications(details);
The the details
parameter allows you to specify a userInfo
dictionary that can be used to match one or more scheduled notifications. Each
matched notification is cancelled and its alerts removed from the notification centre. The RN docs suggest this is an optional parameter, but
it is not.
PushNotification;
2) cancelRemoteNotifications
PushNotification.cancelRemoteNotifications(details);
The the details
parameter allows you to specify a remote notification Id. Each matched notification is cancelled and its alerts removed from
the notification centre. The RN docs suggest this is an optional parameter, but it is not. (Currently, this API is only used in Android and
the fix id of push notification is '1' by default')
PushNotification;
3) cancelAllLocalNotifications
PushNotification.cancelAllLocalNotifications()
Cancels all scheduled notifications AND clears the notifications alerts that are in the notification centre.
NOTE: there is currently no api for removing specific notification alerts from the notification centre.
Repeating Notifications
(Android only) Specify repeatType
and optionally repeatTime
while scheduling the local notification. Check the local notification example above.
For iOS, the repeating notification should land soon. It has already been merged to the master
Notification Actions
(Android only) Refer to this issue to see an example of a notification action.
Two things are required to setup notification actions.
1) Specify notification actions for a notification
This is done by specifying an actions
parameters while configuring the local notification. This is an array of strings where each string is a notificaiton action that will be presented with the notification.
For e.g. actions: '["Accept", "Reject"]' // Must be in string format
The array itself is specified in string format to circumvent some problems because of the way JSON arrays are handled by react-native android bridge.
2) Specify handlers for the notification actions
For each action specified in the actions
field, we need to add a handler that is called when the user clicks on the action. This can be done in the componentWillMount
of your main app file or in a separate file which is imported in your main app file. Notification actions handlers can be configured as below:
import PushNotificationAndroid from 'react-native-push-notification'
(function() {
// Register all the valid actions for notifications here and add the action handler for each action
PushNotificationAndroid.registerNotificationActions(['Accept','Reject','Yes','No']);
DeviceEventEmitter.addListener('notificationActionReceived', function(action){
console.log ('Notification action received: ' + action);
const info = JSON.parse(action.dataJSON);
if (info.action == 'Accept') {
// Do work pertaining to Accept action here
} else if (info.action == 'Reject') {
// Do work pertaining to Reject action here
}
// Add all the required actions handlers
});
})();
For iOS, you can use this package to add notification actions.
Set application badge icon
PushNotification.setApplicationIconBadgeNumber(number: number)
Works natively in iOS.
Uses the ShortcutBadger on Android, and as such will not work on all Android devices.
Sending Notification Data From Server
Same parameters as PushNotification.localNotification()
iOS Only Methods
PushNotification.checkPermissions(callback: Function)
Check permissions
PushNotification.getApplicationIconBadgeNumber(callback: Function)
get badge number
PushNotification.abandonPermissions()
Abandon permissions