Oreo updates

.npmignore

@@ -57,3 +57,6 @@ react-native-notifications.iml
 .idea
 .gradle
 local.properties
+
+# Example app
+example

CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [3.1.1] - 2018-07-31
+
+## Added
+- Android Oreo support (SDK >= 26) (PR [#657](https://github.com/zo0r/react-native-push-notification/pull/657))
+- Firebase (FCM) Support (PR [#717](https://github.com/zo0r/react-native-push-notification/pull/717))
+- Twilio support (PR [#744](https://github.com/zo0r/react-native-push-notification/pull/744))
+- clearLocalNotification (PR [#711](https://github.com/zo0r/react-native-push-notification/pull/711))
+
+## Fixed
+- checkPermissions (PR [#721](https://github.com/zo0r/react-native-push-notification/pull/721))
+- Remove default alert for silent push (PR [#707](https://github.com/zo0r/react-native-push-notification/pull/707))
+
+[Unreleased]: https://github.com/zo0r/react-native-push-notification/compare/v3.1.1...HEAD
+[3.1.1]: https://github.com/zo0r/react-native-push-notification/compare/...v3.1.1

README.md

@@ -13,11 +13,13 @@ React Native Local and Remote Notifications for iOS and Android
 | **2.0.2**          | **0.30, 0.31, 0.32**   | [Open](https://github.com/zo0r/react-native-push-notification/blob/a0f7d44e904ba0b92933518e5bf6b444f1c90abb/README.md)   |
 | **>= 2.1.0**          | **>= 0.33**   | [Open](https://github.com/zo0r/react-native-push-notification/blob/a359e5c00954aa324136eaa9808333d6ca246171/README.md)   |
 
+## Changelog
+Changelog is available from version 3.1.1 here: [Changelog](https://github.com/zo0r/react-native-push-notification/blob/master/CHANGELOG.md)
 
 ## Installation
-`npm install --save react-native-push-notification`
+`npm install --save react-native-push-notification` or `yarn add react-native-push-notification`
 
-`react-native link`
+`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.**
 
@@ -36,32 +38,48 @@ The component uses PushNotificationIOS for the iOS part.
 
 ## 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):**
-```gradle
-...
-
-dependencies {
-    ...
+**NOTE: To use a specific `play-service-gcm` or `firebase-messaging` version:**
 
-    compile project(':react-native-push-notification')
-    compile ('com.google.android.gms:play-services-gcm:8.1.0') {
-        force = true;
-    }
+In your `android/build.gradle`
+```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`
 ```xml
     .....
+    <!-- < Only if you're using GCM or localNotificationSchedule() > -->
     <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" />
+    <!-- < Only if you're using GCM or localNotificationSchedule() > -->
+
     <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 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="@android:color/white"/>
+
+        <!-- < Only if you're using GCM or localNotificationSchedule() > -->
         <receiver
             android:name="com.google.android.gms.gcm.GcmReceiver"
             android:exported="true"
@@ -71,6 +89,7 @@ In your `AndroidManifest.xml`
                 <category android:name="${applicationId}" />
             </intent-filter>
         </receiver>
+        <!-- < Only if you're using GCM or localNotificationSchedule() > -->
 
         <receiver android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationPublisher" />
         <receiver android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationBootEventReceiver">
@@ -79,25 +98,44 @@ In your `AndroidManifest.xml`
             </intent-filter>
         </receiver>
         <service android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationRegistrationService"/>
+
+        <!-- < Only if you're using GCM or localNotificationSchedule() > -->
         <service
-            android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationListenerService"
+            android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationListenerServiceGcm"
             android:exported="false" >
             <intent-filter>
                 <action android:name="com.google.android.c2dm.intent.RECEIVE" />
             </intent-filter>
         </service>
+        <!-- </ Only if you're using GCM or localNotificationSchedule() > -->
+
+        <!-- < Else > -->
+        <service
+            android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationListenerService"
+            android:exported="false" >
+            <intent-filter>
+                <action android:name="com.google.firebase.MESSAGING_EVENT" />
+            </intent-filter>
+        </service>
+        <!-- </Else> -->
      .....
 
 ```
 
 In `android/settings.gradle`
 ```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).
+```xml
+<resources>
+    <color name="white">#FFF</color>
+</resources>
+```
+
 Manually register module in `MainApplication.java` (if you did not use `react-native link`):
 
 ```java
@@ -139,10 +177,15 @@ PushNotification.configure({
     // (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",
+    // ANDROID ONLY: GCM or FCM Sender ID (product_number) (optional - not required for local notifications, but is need to receive remote push notifications)
+    senderID: "YOUR GCM (OR FCM) SENDER ID",
 
     // IOS ONLY (optional): default: all - Permissions to register.
     permissions: {
@@ -164,6 +207,12 @@ PushNotification.configure({
 });
 ```
 
+## 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](https://www.pushwatch.com/gcm/).
+
+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.
 
@@ -197,19 +246,22 @@ PushNotification.localNotification({
     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
 
     /* 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, for iOS this is only used in apple watch, the title will be the app name on other iOS devices)
+    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', // (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 interval
+    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
 });
 ```
@@ -220,6 +272,7 @@ PushNotification.localNotification({
 EXAMPLE:
 ```javascript
 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
 });
@@ -239,16 +292,75 @@ In the location notification json specify the full file name:
 
 ### 1) cancelLocalNotifications
 
-`PushNotification.cancelLocalNotifications(details);`
+#### Android
+The `id` parameter for `PushNotification.localNotification` is required for this operation. The id supplied will then be used for the cancel operation.
 
-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.
+```javascript
+// Android
+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.
 ```javascript
+// IOS
+PushNotification.localNotification({
+    ...
+    userInfo: { id: '123' }
+    ...
+});
 PushNotification.cancelLocalNotifications({id: '123'});
 ```
 
+
 ### 2) cancelAllLocalNotifications
 
 `PushNotification.cancelAllLocalNotifications()`
@@ -259,9 +371,9 @@ Cancels all scheduled notifications AND clears the notifications alerts that are
 
 ## Repeating Notifications ##
 
-(Android only) Specify `repeatType` and optionally `repeatTime` while scheduling the local notification. Check the local notification example above.
+(optional) 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](https://github.com/facebook/react-native/pull/10337)
+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 ##
 
@@ -270,7 +382,7 @@ For iOS, the repeating notification should land soon. It has already been merged
 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.
+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`
 
@@ -311,9 +423,20 @@ Uses the [ShortcutBadger](https://github.com/leolin310148/ShortcutBadger) on And
 ## Sending Notification Data From Server
 Same parameters as `PushNotification.localNotification()`
 
-## iOS Only Methods
+## Android Only Methods
+
+`PushNotification.subscribeToTopic(topic: string)` Subscribe to a topic (works only with Firebase)
+
+## Checking Notification Permissions
 `PushNotification.checkPermissions(callback: Function)` Check permissions
 
-`PushNotification.getApplicationIconBadgeNumber(callback: Function)` get badge number
+`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

android/build.gradle

@@ -15,13 +15,20 @@ allprojects {
 
 apply plugin: 'com.android.library'
 
+def DEFAULT_COMPILE_SDK_VERSION = 27
+def DEFAULT_BUILD_TOOLS_VERSION = "27.0.3"
+def DEFAULT_TARGET_SDK_VERSION = 27
+def DEFAULT_SUPPORT_LIB_VERSION = "27.1.1"
+def DEFAULT_GOOGLE_PLAY_SERVICES_VERSION = "+"
+def DEFAULT_FIREBASE_MESSAGING_VERSION = "+"
+
 android {
-    compileSdkVersion 23
-    buildToolsVersion "23.0.1"
+    compileSdkVersion project.hasProperty('compileSdkVersion') ? project.compileSdkVersion : DEFAULT_COMPILE_SDK_VERSION
+    buildToolsVersion project.hasProperty('buildToolsVersion') ? project.buildToolsVersion : DEFAULT_BUILD_TOOLS_VERSION
 
     defaultConfig {
         minSdkVersion 16
-        targetSdkVersion 23
+        targetSdkVersion project.hasProperty('targetSdkVersion') ? project.targetSdkVersion : DEFAULT_TARGET_SDK_VERSION
         versionCode 1
         versionName "1.0"
         ndk {
@@ -37,10 +44,15 @@ android {
 }
 
 dependencies {
+    def supportLibVersion = project.hasProperty('supportLibVersion') ? project.supportLibVersion : DEFAULT_SUPPORT_LIB_VERSION
+    def googlePlayServicesVersion = project.hasProperty('googlePlayServicesVersion') ? project.googlePlayServicesVersion : DEFAULT_GOOGLE_PLAY_SERVICES_VERSION
+    def firebaseVersion = project.hasProperty('firebaseVersion') ? project.firebaseVersion : DEFAULT_FIREBASE_MESSAGING_VERSION
+
     compile fileTree(dir: 'libs', include: ['*.jar'])
     testCompile 'junit:junit:4.12'
-    compile 'com.android.support:appcompat-v7:23.1.1'
+    compile "com.android.support:appcompat-v7:$supportLibVersion"
     compile 'com.facebook.react:react-native:+'
-    compile 'com.google.android.gms:play-services-gcm:+'
+    compile "com.google.android.gms:play-services-gcm:$googlePlayServicesVersion"
     compile 'me.leolin:ShortcutBadger:1.1.8@aar'
+    compile "com.google.firebase:firebase-messaging:$firebaseVersion"
 }