@brandingbrand/react-native-push-notification-leanplum
v4.1.0
Published
React Native Local and Remote Notifications
Downloads
35
Readme
This package is forked from @zo0r/react-native-push-notification specifically for the use case of handling Android push notifications through Leanplum.
Customizing Leanplum SDK version (Android):
This fork exposes an additional confirguration allowing you to specify the version of the Android Leanplum SDK to use. Add the following to your project's android/build.gradle file:
ext {
leanplumVersion = "<Your Leanplum version>" // default: "+"
}
The original package's README is below:
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
npm install --save react-native-push-notification
Yarn
yarn add 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
iOS manual Installation
The component uses PushNotificationIOS for the iOS part.
Please see: PushNotificationIOS
Android manual Installation
NOTE: 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: "+"
firebaseMessagingVersion = "<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 android/app/src/main/AndroidManifest.xml
.....
<uses-permission android:name="android.permission.WAKE_LOCK" />
<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"/>
<!-- Change the value to true to enable pop-up for in foreground (remote-only, for local use ignoreInForeground) -->
<meta-data android:name="com.dieam.reactnativepushnotification.notification_foreground"
android:value="false"/>
<!-- Change the resource name to your App's accent color - or any other color you want -->
<meta-data android:name="com.dieam.reactnativepushnotification.notification_color"
android:resource="@color/white"/> <!-- or @android:color/{name} to use a standard color -->
<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.RNPushNotificationListenerService"
android:exported="false" >
<intent-filter>
<action android:name="com.google.firebase.MESSAGING_EVENT" />
</intent-filter>
</service>
.....
If not using a built in Android color (@android:color/{name}
) for the notification_color
meta-data
item.
In android/app/src/main/res/values/colors.xml
(Create the file if it doesn't exist).
<resources>
<color name="white">#FFF</color>
</resources>
If you use remote notifications
Make sure you have installed setup Firebase correctly.
In android/build.gradle
buildscript {
...
dependencies {
...
classpath('com.google.gms:google-services:4.3.3')
...
}
}
In android/app/build.gradle
dependencies {
...
implementation 'com.google.firebase:firebase-analytics:17.3.0'
...
}
apply plugin: 'com.google.gms.google-services'
Then put your google-services.json
in android/app/
.
Note: firebase/release-notes
The Firebase Android library
firebase-core
is no longer needed. This SDK included the Firebase SDK for Google Analytics.Now, to use Analytics or any Firebase product that recommends the use of Analytics (see table below), you need to explicitly add the Analytics dependency:
com.google.firebase:firebase-analytics:17.3.0
.
If you don't use autolink
In android/settings.gradle
...
include ':react-native-push-notification'
project(':react-native-push-notification').projectDir = file('../node_modules/react-native-push-notification/android')
In your android/app/build.gradle
dependencies {
...
implementation project(':react-native-push-notification')
...
}
Manually register module in MainApplication.java
(if you did not use react-native link
):
import com.dieam.reactnativepushnotification.ReactNativePushNotificationPackage; // <--- Import Package
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() // <---- Add the Package
);
}
};
....
}
Usage
import PushNotificationIOS from "@react-native-community/push-notification-ios";
var PushNotification = require("react-native-push-notification");
PushNotification.configure({
// (optional) Called when Token is generated (iOS and Android)
onRegister: function (token) {
console.log("TOKEN:", token);
},
// (required) Called when a remote is received or opened, or local notification is opened
onNotification: function (notification) {
console.log("NOTIFICATION:", notification);
// process the notification
// (required) Called when a remote is received or opened, or local notification is opened
notification.finish(PushNotificationIOS.FetchResult.NoData);
},
// IOS ONLY (optional): default: all - Permissions to register.
permissions: {
alert: true,
badge: true,
sound: true,
},
// Should the initial notification be popped automatically
// default: true
popInitialNotification: true,
/**
* (optional) default: true
* - Specified if permissions (ios) and token (android and ios) will requested or not,
* - if not, you must call PushNotificationsHandler.requestPermissions() later
* - if you are not using remote notification or do not have Firebase installed, use this:
* requestPermissions: Platform.OS === 'ios'
*/
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
.
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, // 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.localNotification({
/* Android Only Properties */
id: 0, // (optional) Valid unique 32 bit integer specified as string. default: Autogenerated Unique ID
ticker: "My Notification Ticker", // (optional)
autoCancel: true, // (optional) default: true
largeIcon: "ic_launcher", // (optional) default: "ic_launcher"
smallIcon: "ic_notification", // (optional) default: "ic_notification" with fallback for "ic_launcher"
bigText: "My big text that will be shown when notification is expanded", // (optional) default: "message" prop
subText: "This is a subText", // (optional) default: none
color: "red", // (optional) default: system default
vibrate: true, // (optional) default: true
vibration: 300, // vibration length in milliseconds, ignored if vibrate=false, default: 1000
tag: "some_tag", // (optional) add tag to message
group: "group", // (optional) add group to message
ongoing: false, // (optional) set whether this is an "ongoing" notification
priority: "high", // (optional) set notification priority, default: high
visibility: "private", // (optional) set notification visibility, default: private
importance: "high", // (optional) set notification importance, default: high
allowWhileIdle: false, // (optional) set notification to work while on doze, default: false
ignoreInForeground: false, // (optional) if true, the notification will not be visible when the app is in the foreground (useful for parity with how iOS notifications appear)
/* iOS only properties */
alertAction: "view", // (optional) default: view
category: "", // (optional) default: empty string
userInfo: {}, // (optional) default: {} (using null throws a JSON value '<null>' error)
/* iOS and Android properties */
title: "My Notification Title", // (optional)
message: "My Notification Message", // (required)
playSound: false, // (optional) default: true
soundName: "default", // (optional) Sound to play when the notification is shown. Value of 'default' plays the default sound. It can be set to a custom sound such as 'android.resource://com.xyz/raw/my_sound'. It will look for the 'my_sound' audio file in 'res/raw' directory and play it. default: 'default' (default sound is played)
number: 10, // (optional) Valid 32 bit integer specified as string. default: none (Cannot be zero)
repeatType: "day", // (optional) Repeating interval. Check 'Repeating Notifications' section for more info.
actions: '["Yes", "No"]', // (Android only) See the doc for notification actions to know more
});
Scheduled Notifications
PushNotification.localNotificationSchedule(details: Object)
EXAMPLE:
PushNotification.localNotificationSchedule({
//... You can use all the options from localNotifications
message: "My Notification Message", // (required)
date: new Date(Date.now() + 60 * 1000), // in 60 secs
});
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.
// Android
PushNotification.localNotification({
...
id: '123'
...
});
PushNotification.cancelLocalNotifications({id: '123'});
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.
// IOS
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.
3) removeAllDeliveredNotifications
PushNotificationIOS.removeAllDeliveredNotifications();
Remove all delivered notifications from Notification Center
4) getDeliveredNotifications
PushNotificationIOS.getDeliveredNotifications(callback);
Provides you with a list of the app’s notifications that are still displayed in Notification Center
Parameters:
| Name | Type | Required | Description | | -------- | -------- | -------- | ----------------------------------------------------------- | | callback | function | Yes | Function which receive an array of delivered notifications. |
A delivered notification is an object containing:
identifier
: The identifier of this notification.title
: The title of this notification.body
: The body of this notification.category
: The category of this notification (optional).userInfo
: An object containing additional notification data (optional).thread-id
: The thread identifier of this notification, if has one.
5) removeDeliveredNotifications
PushNotificationIOS.removeDeliveredNotifications(identifiers);
Removes the specified notifications from Notification Center
Parameters:
| Name | Type | Required | Description | | ----------- | ----- | -------- | ---------------------------------- | | identifiers | array | Yes | Array of notification identifiers. |
Abandon Permissions
PushNotification.abandonPermissions()
Revokes the current token and unregister for all remote notifications received via APNS or FCM.
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
Notification while idle
(optional) Specify allowWhileIdle
to set if the notification should be allowed to execute even when the system is on low-power idle modes.
On Android 6.0 (API level 23) and forward, the Doze was introduced to reduce battery consumption when the device is unused for long periods of time. But while on Doze the AlarmManager alarms (used to show scheduled notifications) are deferred to the next maintenance window. This may cause the notification to be delayed while on Doze.
This can significantly impact the power use of the device when idle. So it must only be used when the notification is required to go off on a exact time, for example on a calendar notification.
More information: https://developer.android.com/training/monitoring-device-state/doze-standby
Repeating Notifications
(optional) Specify repeatType
and optionally repeatTime
(Android-only) 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)
PushNotification.unsubscribeFromTopic(topic: string)
Unsubscribe from 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