Supported React Native Versions

Installation

Issues

Pull Requests

iOS manual Installation

Android manual Installation

...dependencies {...    compile project(':react-native-push-notification')    compile ('com.google.android.gms:play-services-gcm:8.1.0') {        force=true;    }}

    .....    <uses-permissionandroid:name="android.permission.WAKE_LOCK" />    <permissionandroid:name="${applicationId}.permission.C2D_MESSAGE"android:protectionLevel="signature" />    <uses-permissionandroid:name="${applicationId}.permission.C2D_MESSAGE" />    <uses-permissionandroid:name="android.permission.VIBRATE" />    <uses-permissionandroid:name="android.permission.RECEIVE_BOOT_COMPLETED"/>    <application ....>        <receiverandroid:name="com.google.android.gms.gcm.GcmReceiver"android:exported="true"android:permission="com.google.android.c2dm.permission.SEND" >            <intent-filter>                <actionandroid:name="com.google.android.c2dm.intent.RECEIVE" />                <categoryandroid:name="${applicationId}" />            </intent-filter>        </receiver>        <receiverandroid:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationPublisher" />        <receiverandroid:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationBootEventReceiver">            <intent-filter>                <actionandroid:name="android.intent.action.BOOT_COMPLETED" />            </intent-filter>        </receiver>        <serviceandroid:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationRegistrationService"/>        <serviceandroid:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationListenerService"android:exported="false" >            <intent-filter>                <actionandroid:name="com.google.android.c2dm.intent.RECEIVE" />            </intent-filter>        </service>     .....

...include':react-native-push-notification'project(':react-native-push-notification').projectDir= file('../node_modules/react-native-push-notification/android')

importcom.dieam.reactnativepushnotification.ReactNativePushNotificationPackage;// <--- Import PackagepublicclassMainApplicationextendsApplicationimplementsReactApplication {privatefinalReactNativeHostmReactNativeHost =newReactNativeHost(this) {@OverrideprotectedbooleangetUseDeveloperSupport() {returnBuildConfig.DEBUG;      }@OverrideprotectedList<ReactPackage>getPackages() {returnArrays.<ReactPackage>asList(newMainReactPackage(),newReactNativePushNotificationPackage()// <---- Add the Package      );    }  };  ....}

Usage

varPushNotification=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 or local notification is opened or receivedonNotification:function(notification){console.log('NOTIFICATION:',notification);},// ANDROID ONLY: GCM Sender ID (optional - not required for local notifications, but is need to receive remote push notifications)senderID:"YOUR GCM SENDER ID",// IOS ONLY (optional): default: all - Permissions to register.permissions:{alert:true,badge:true,sound:true},// Should the initial notification be popped automatically// default: truepopInitialNotification: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      */requestPermissions:true,});

Handling Notifications

{foreground:false,// BOOLEAN: If the notification was received in foreground or notuserInteraction:false,// BOOLEAN: If the notification was opened by the user from the notification area or notmessage:'My Notification Message',// STRING: The notification messagedata:{},// OBJECT: The push data}

Local Notifications

PushNotification.localNotification({/* Android Only Properties */id:'0',// (optional) Valid unique 32 bit integer specified as string. default: Autogenerated Unique IDticker:"My Notification Ticker",// (optional)autoCancel:true,// (optional) default: truelargeIcon:"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" propsubText:"This is a subText",// (optional) default: nonecolor:"red",// (optional) default: system defaultvibrate:true,// (optional) default: truevibration:300,// vibration length in milliseconds, ignored if vibrate=false, default: 1000tag:'some_tag',// (optional) add tag to messagegroup:"group",// (optional) add group to messageongoing:false,// (optional) set whether this is an "ongoing" notification/* iOS only properties */alertAction:// (optional) default: viewcategory:// (optional) default: nulluserInfo:// (optional) default: null (object containing additional notification data)/* iOS and Android properties */title:"My Notification Title",// (optional, for iOS this is only used in apple watch, the title will be the app name on other iOS devices)message:"My Notification Message",// (required)playSound:false,// (optional) default: truesoundName:'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',// (Android only) Repeating interval. Could be one of `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 intervalactions:'["Yes", "No"]',// (Android only) See the doc for notification actions to know more});

Scheduled Notifications

PushNotification.localNotificationSchedule({message:"My Notification Message",// (required)date:newDate(Date.now()+(60*1000))// in 60 secs});

Custom sounds

soundName: 'my_sound.mp3'

Cancelling notifications

1) cancelLocalNotifications

PushNotification.cancelLocalNotifications({id:'123'});

2) cancelAllLocalNotifications

Repeating Notifications

Notification Actions

1) Specify notification actions for a notification

2) Specify handlers for the notification actions

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  });})();

Set application badge icon

Sending Notification Data From Server

iOS Only Methods