Nonstop Perpetual Motion

    @datacamp/react-native-push-notification

    3.0.8 • Public • Published

    React Native Push Notifications

    npm version npm downloads

    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

    Installation

    npm install --save react-native-push-notification

    react-native link

    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: To use a specific play-service-gcm version:

    In your android/build.gradle

    ext {
        googlePlayServicesVersion = "<Your play services 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 ....>
            <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.RNPushNotificationListenerService"
                android:exported="false" >
                <intent-filter>
                    <action android:name="com.google.android.c2dm.intent.RECEIVE" />
                </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')

    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

    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 or local notification is opened or received
        onNotification: function(notification) {
            console.log( 'NOTIFICATION:', notification );
    
            // process the notification
    
            // required on iOS only (see fetchCompletionHandler docs: https://facebook.github.io/react-native/docs/pushnotificationios.html)
            notification.finish(PushNotificationIOS.FetchResult.NoData);
        },
    
        // 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: 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
          */
        requestPermissions: true,
    });

    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
    
        /* iOS only properties */
        alertAction: // (optional) default: view
        category: // (optional) default: null
        userInfo: // (optional) default: null (object containing additional notification data)
    
        /* 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.

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

    Checking Notification Permissions

    PushNotification.checkPermissions(callback: Function) Check permissions

    callback will be invoked with a permissions object:

    • alert: boolean
    • badge: boolean
    • sound: boolean

    iOS Only Methods

    PushNotification.getApplicationIconBadgeNumber(callback: Function) Get badge number

    PushNotification.abandonPermissions() Abandon permissions

    Install

    npm i @datacamp/react-native-push-notification

    DownloadsWeekly Downloads

    19

    Version

    3.0.8

    License

    MIT

    Unpacked Size

    112 kB

    Total Files

    23

    Last publish

    Collaborators

    • vvankrunkelsven
    • evertet
    • bereketmebrahtu
    • marbdq-dc
    • mzetea
    • jang_dc
    • jboguski-dc
    • yunchen44
    • thomasbeckx
    • frederikvg
    • nhlongnguyen
    • bobby.clare
    • nathandatacamp
    • cdalby
    • luigi-dintrono-dc
    • eoliveiradc
    • berndschrooten
    • _bogdan_floris_
    • denathoxhadc
    • sajtempler-dc
    • bartlens
    • kyryl_kurylchenko
    • filipsch
    • meehirpateldatacamp
    • malex-datacamp
    • gillvdw
    • slava-dc
    • ztsorojev
    • smidge
    • alanhughesdatacamp
    • catufuzgu
    • felipeneuhauss
    • joachimzeelmaekers
    • garyalway
    • jdmunro
    • hettiemcc
    • close-d-dev
    • herve-eerebout
    • ddmkr
    • dandenney
    • entropitor
    • ewaldbervoets
    • cnydw
    • rikbw
    • nicolasdesmedt
    • lazzystep
    • abordanpeter
    • aarondc
    • hermansje
    • nunorafaelrocha
    • thomascorthouts
    • nickvdyck
    • timsangster
    • tuur
    • lipsumar
    • caterina
    • datacamp-org
    • chrisramakers
    • irakli_dc
    • ppetermann
    • springerigor
    • iryna059
    • louiejakebell
    • blurbyte
    • kogitoja
    • larisa-datacamp
    • rahien
    • samwooler
    • forvalho
    • stijnj
    • deanterweduwe
    • bruno.datacamp
    • marcin-data
    • julienbenaouda