React Native Push Notifications

React Native Local and Remote Notifications for iOS and Android
Supported React Native Versions
Component Version | RN Versions | README |
---|
1.0.7 | <= 0.27 | Open |
1.0.8 | 0.28 | Open |
2.0.1 | 0.29 | Open |
2.0.2 | 0.30, 0.31, 0.32 | Open |
>= 2.1.0 | >= 0.33 | Open |
Changelog
Changelog is available from version 3.1.3 here: Changelog
Installation
npm install --save react-native-push-notification
or yarn add react-native-push-notification
react-native link react-native-push-notification
NOTE: For Android, you will still have to manually update the AndroidManifest.xml (as below) in order to use Scheduled Notifications.
Issues
Having a problem? Read the troubleshooting guide before raising an issue.
Pull Requests
Please read...
iOS manual Installation
The component uses PushNotificationIOS for the iOS part.
Please see: PushNotificationIOS
Android manual Installation
NOTE: play-service-gcm
and firebase-messaging
, prior to version 15 requires to have the same version number in order to work correctly at build time and at run time. To use a specific version:
In your android/build.gradle
ext {
googlePlayServicesVersion = "<Your play services version>" // default: "+"
firebaseVersion = "<Your Firebase version>" // default: "+"
// Other settings
compileSdkVersion = <Your compile SDK version> // default: 23
buildToolsVersion = "<Your build tools version>" // default: "23.0.1"
targetSdkVersion = <Your target SDK version> // default: 23
supportLibVersion = "<Your support lib version>" // default: 23.1.1
}
NOTE: localNotification() works without changes in the application part, while localNotificationSchedule() only works with these changes:
In your AndroidManifest.xml
.....
<uses-permission android:name="android.permission.WAKE_LOCK" />
<permission
android:name="${applicationId}.permission.C2D_MESSAGE"
android:protectionLevel="signature" />
<uses-permission android:name="${applicationId}.permission.C2D_MESSAGE" />
<uses-permission android:name="android.permission.VIBRATE" />
<uses-permission android:name="android.permission.RECEIVE_BOOT_COMPLETED"/>
<application ....>
<meta-data android:name="com.dieam.reactnativepushnotification.notification_channel_name"
android:value="YOUR NOTIFICATION CHANNEL NAME"/>
<meta-data android:name="com.dieam.reactnativepushnotification.notification_channel_description"
android:value="YOUR NOTIFICATION CHANNEL DESCRIPTION"/>
<meta-data android:name="com.dieam.reactnativepushnotification.notification_color"
android:resource="@android:color/white"/>
<receiver
android:name="com.google.android.gms.gcm.GcmReceiver"
android:exported="true"
android:permission="com.google.android.c2dm.permission.SEND" >
<intent-filter>
<action android:name="com.google.android.c2dm.intent.RECEIVE" />
<category android:name="${applicationId}" />
</intent-filter>
</receiver>
<receiver android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationPublisher" />
<receiver android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationBootEventReceiver">
<intent-filter>
<action android:name="android.intent.action.BOOT_COMPLETED" />
</intent-filter>
</receiver>
<service android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationRegistrationService"/>
<service
android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationListenerServiceGcm"
android:exported="false" >
<intent-filter>
<action android:name="com.google.android.c2dm.intent.RECEIVE" />
</intent-filter>
</service>
<service
android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationListenerService"
android:exported="false" >
<intent-filter>
<action android:name="com.google.firebase.MESSAGING_EVENT" />
</intent-filter>
</service>
.....
In android/settings.gradle
...
include ':react-native-push-notification'
project(':react-native-push-notification').projectDir = file('../node_modules/react-native-push-notification/android')
In android/app/src/res/values/colors.xml
(Create the file if it doesn't exist).
<resources>
<color name="white">#FFF</color>
</resources>
Manually register module in MainApplication.java
(if you did not use react-native link
):
import com.dieam.reactnativepushnotification.ReactNativePushNotificationPackage;
public class MainApplication extends Application implements ReactApplication {
private final ReactNativeHost mReactNativeHost = new ReactNativeHost(this) {
@Override
protected boolean getUseDeveloperSupport() {
return BuildConfig.DEBUG;
}
@Override
protected List<ReactPackage> getPackages() {
return Arrays.<ReactPackage>asList(
new MainReactPackage(),
new ReactNativePushNotificationPackage()
);
}
};
....
}
Usage
var PushNotification = require("react-native-push-notification");
PushNotification.configure({
onRegister: function(token) {
console.log("TOKEN:", token);
},
onNotification: function(notification) {
console.log("NOTIFICATION:", notification);
notification.finish(PushNotificationIOS.FetchResult.NoData);
},
senderID: "YOUR GCM (OR FCM) SENDER ID",
permissions: {
alert: true,
badge: true,
sound: true
},
popInitialNotification: true,
requestPermissions: true
});
Example app
Example folder contains an example app to demonstrate how to use this package. The notification Handling is done in NotifService.js
. For Remote notifications, configure your SenderId in app.json
. You can also edit it directly in the app.
To send Push notifications, you can use the online tool PushWatch.
Please test your PRs with this example app before submitting them. It'll help maintaining this repo.
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,
userInteraction: false,
message: 'My Notification Message',
data: {},
}
Local Notifications
PushNotification.localNotification(details: Object)
EXAMPLE:
PushNotification.localNotification({
id: '0',
ticker: "My Notification Ticker",
autoCancel: true,
largeIcon: "ic_launcher",
smallIcon: "ic_notification",
bigText: "My big text that will be shown when notification is expanded",
subText: "This is a subText",
color: "red",
vibrate: true,
vibration: 300,
tag: 'some_tag',
group: "group",
ongoing: false,
priority: "high",
visibility: "private",
importance: "high",
alertAction:
category:
userInfo:
title: "My Notification Title",
message: "My Notification Message",
playSound: false,
soundName: 'default',
number: '10',
repeatType: 'day',
actions: '["Yes", "No"]',
});
Scheduled Notifications
PushNotification.localNotificationSchedule(details: Object)
EXAMPLE:
PushNotification.localNotificationSchedule({
message: "My Notification Message",
date: new Date(Date.now() + 60 * 1000)
});
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
Android
The id
parameter for PushNotification.localNotification
is required for this operation. The id supplied will then be used for the cancel operation.
PushNotification.localNotification({
...
id: '123'
...
});
PushNotification.cancelLocalNotifications({id: '123'});
Notification priority
(optional) Specify priority
to set priority of notification. Default value: "high"
Available options:
"max" = NotficationCompat.PRIORITY_MAX
"high" = NotficationCompat.PRIORITY_HIGH
"low" = NotficationCompat.PRIORITY_LOW
"min" = NotficationCompat.PRIORITY_MIN
"default" = NotficationCompat.PRIORITY_DEFAULT
More information: https://developer.android.com/reference/android/app/Notification.html#PRIORITY_DEFAULT
Notification visibility
(optional) Specify visibility
to set visibility of notification. Default value: "private"
Available options:
"private" = NotficationCompat.VISIBILITY_PRIVATE
"public" = NotficationCompat.VISIBILITY_PUBLIC
"secret" = NotficationCompat.VISIBILITY_SECRET
More information: https://developer.android.com/reference/android/app/Notification.html#VISIBILITY_PRIVATE
Notification importance
(optional) Specify importance
to set importance of notification. Default value: "high"
Available options:
"default" = NotificationManager.IMPORTANCE_DEFAULT
"max" = NotificationManager.IMPORTANCE_MAX
"high" = NotificationManager.IMPORTANCE_HIGH
"low" = NotificationManager.IMPORTANCE_LOW
"min" = NotificationManager.IMPORTANCE_MIN
"none" = NotificationManager.IMPORTANCE_NONE
"unspecified" = NotificationManager.IMPORTANCE_UNSPECIFIED
More information: https://developer.android.com/reference/android/app/NotificationManager#IMPORTANCE_DEFAULT
IOS
The userInfo
parameter for PushNotification.localNotification
is required for this operation and must contain an id
parameter. The id supplied will then be used for the cancel operation.
PushNotification.localNotification({
...
userInfo: { id: '123' }
...
});
PushNotification.cancelLocalNotifications({id: '123'});
2) 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
(optional) Specify repeatType
and optionally repeatTime
while scheduling the local notification. Check the local notification example above.
Property repeatType
could be one of month
, week
, day
, hour
, minute
, time
. If specified as time, it should be accompanied by one more parameter repeatTime
which should the number of milliseconds between each interval.
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 notification 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()
Android Only Methods
PushNotification.subscribeToTopic(topic: string)
Subscribe to a topic (works only with Firebase)
Checking Notification Permissions
PushNotification.checkPermissions(callback: Function)
Check permissions
callback
will be invoked with a permissions
object:
alert
: booleanbadge
: booleansound
: boolean
iOS Only Methods
PushNotification.getApplicationIconBadgeNumber(callback: Function)
Get badge number
PushNotification.abandonPermissions()
Abandon permissions