Prepare next release

Author: Dallas62

CHANGELOG.md

@@ -8,10 +8,37 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 ### Breaking changes
 
+- (Android) Channel Management: In order to limit the scope of responsability of this library, developers are now responsible of the creation of the channels. You can find the documentation at https://github.com/zo0r/react-native-push-notification#channel-management-android. These changes are also made to allow improvements in the future of the library. Here the list of impacts:
+  - You must create your channels before triggering a notification.
+  - These entries in `AndroidManifest` are deprecated:
+  ```xml
+        <meta-data android:name="com.dieam.reactnativepushnotification.notification_channel_name" android:value="..."/>
+        <meta-data android:name="com.dieam.reactnativepushnotification.notification_channel_description" android:value="..."/>
+        <meta-data android:name="com.dieam.reactnativepushnotification.channel_create_default" android:value="..."/>
+  ```
+  -  Followings options changed on Android in `localNotification` and `localNotificationSchedule`:
+     - `channelId` becomes mandatory (warning if not provided)
+     - `channelName` is deprecated
+     - `channelDescription` is deprecated
+     - `importance` is deprecated
+  - These changes help to avoid an issue [#1649](https://github.com/zo0r/react-native-push-notification/issues/1649)
+- (Android) Remove check for the intent `BOOT_COMPLETED`, this should allow more intent action such as `QUICKBOOT_POWERON`. It's recommended to update `AndroidManifest`, the `RNPushNotificationBootEventReceiver` to:
+  ```xml
+        <receiver android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationBootEventReceiver">
+            <intent-filter>
+                <action android:name="android.intent.action.BOOT_COMPLETED" />
+                <action android:name="android.intent.action.QUICKBOOT_POWERON" />
+                <action android:name="com.htc.intent.action.QUICKBOOT_POWERON"/>
+            </intent-filter>
+        </receiver>
+  ```
 - `@react-native-community/push-notification-ios` is now a `peerDependency`, please make sure that you installed this library with NPM or YARN.
 - (Android) Fix a bug where notification data are not inside `data` property after been pressed by user. When sending notification + data and app in background.
-
-### Features
+- (Android) Add more fields from the firebase notification part. (Thanks to @fattomhk with this PR [#1626](https://github.com/zo0r/react-native-push-notification/pull/1626))
+  - `notificationPriority`
+  - `image`
+  - `tag`
+  - `visibility`
 
 ### Fixed
 

README.md

@@ -89,17 +89,9 @@ In your `android/app/src/main/AndroidManifest.xml`
     <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 value to false if you don't want the creation of the default channel -->
-        <meta-data  android:name="com.dieam.reactnativepushnotification.channel_create_default"
-                    android:value="true"/>
         <!-- 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 -->
@@ -109,6 +101,8 @@ In your `android/app/src/main/AndroidManifest.xml`
         <receiver android:name="com.dieam.reactnativepushnotification.modules.RNPushNotificationBootEventReceiver">
             <intent-filter>
                 <action android:name="android.intent.action.BOOT_COMPLETED" />
+                <action android:name="android.intent.action.QUICKBOOT_POWERON" />
+                <action android:name="com.htc.intent.action.QUICKBOOT_POWERON"/>
             </intent-filter>
         </receiver>
 
@@ -307,6 +301,7 @@ EXAMPLE:
 ```javascript
 PushNotification.localNotification({
   /* Android Only Properties */
+  channelId: "your-channel-id", // (required) channelId, if the channel doesn't exist, it will be created with options passed above (importance, vibration, sound). Once the channel is created, the channel will not be update. Make sure your channelId is different if you change these options. If you have created a custom channel, it will apply options of the channel.
   ticker: "My Notification Ticker", // (optional)
   showWhen: true, // (optional) default: true
   autoCancel: true, // (optional) default: true
@@ -325,10 +320,8 @@ PushNotification.localNotification({
   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
   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)
   shortcutId: "shortcut-id", // (optional) If this notification is duplicative of a Launcher shortcut, sets the id of the shortcut, in case the Launcher wants to hide the shortcut, default undefined
-  channelId: "your-custom-channel-id", // (optional) custom channelId, if the channel doesn't exist, it will be created with options passed above (importance, vibration, sound). Once the channel is created, the channel will not be update. Make sure your channelId is different if you change these options. If you have created a custom channel, it will apply options of the channel.
   onlyAlertOnce: false, // (optional) alert will open only once with sound and notify, default: false
 
   when: null, // (optionnal) Add a timestamp pertaining to the notification (usually the time the event occurred). For apps targeting Build.VERSION_CODES.N and above, this time is not shown anymore by default and must be opted into by using `showWhen`, default: null.
@@ -337,7 +330,7 @@ PushNotification.localNotification({
 
   messageId: "google:message_id", // (optional) added as `message_id` to intent extras so opening push notification can find data stored by @react-native-firebase/messaging module. 
 
-  actions: '["Yes", "No"]', // (Android only) See the doc for notification actions to know more
+  actions: ["Yes", "No"], // (Android only) See the doc for notification actions to know more
   invokeApp: true, // (optional) This enable click on actions to bring back the application to foreground or stay in background, default: true
 
   /* iOS only properties */
@@ -395,14 +388,14 @@ In the location notification json specify the full file name:
 
 ## Channel Management (Android)
 
-To use custom channels, create them at startup and pass the matching `channelId` through to `PushNotification.localNotification`
+To use channels, create them at startup and pass the matching `channelId` through to `PushNotification.localNotification` or `PushNotification.localNotificationSchedule`.
 
 ```javascript
   PushNotification.createChannel(
     {
-      channelId: "custom-channel-id", // (required)
-      channelName: "Custom channel", // (required)
-      channelDescription: "A custom channel to categorise your custom notifications", // (optional) default: undefined.
+      channelId: "channel-id", // (required)
+      channelName: "My channel", // (required)
+      channelDescription: "A channel to categorise your notifications", // (optional) default: undefined.
       soundName: "default", // (optional) See `soundName` parameter of `localNotification` function
       importance: 4, // (optional) default: 4. Int value of the Android notification importance
       vibrate: true, // (optional) default: true. Creates the default vibration patten if true.
@@ -411,47 +404,9 @@ To use custom channels, create them at startup and pass the matching `channelId`
   );
 ```
 
-Channels with ids that do not exist are generated on the fly when you pass options to `PushNotification.localNotification` or `PushNotification.localNotificationSchedule`.
-
-The pattern of `channel_id` is:
-
-```
-rn-push-notification-channel-id-(importance: default "4")(-soundname, default if playSound "-default")-(vibration, default "300")
-```
-
-By default, 1 channel is created:
-
-- rn-push-notification-channel-id-4-default-300 (used for remote notification if none already exist).
-
-you can avoid the default creation by using this:
-
-```xml
-  <meta-data  android:name="com.dieam.reactnativepushnotification.channel_create_default"
-          android:value="false"/>
-```
-
 **NOTE: Without channel, remote notifications don't work**
 
-In the notifications options, you can provide a custom channel id with `channelId: "your-custom-channel-id"`, if the channel doesn't exist, it will be created with options passed above (importance, vibration, sound). Once the channel is created, the channel will not be update. Make sure your `channelId` is different if you change these options. If you have created a custom channel in another way, it will apply options of the channel.
-
-Custom and generated channels can have custom name and description in the `AndroidManifest.xml`, only if the library is responsible of the creation of the channel.
-You can also use `channelName` and `channelDescription` when you use to override the name or description. Once the channel is created, you won't be able to update them.
-
-```xml
-  <meta-data  android:name="com.dieam.reactnativepushnotification.notification_channel_name.[CHANNEL_ID]"
-          android:value="YOUR NOTIFICATION CHANNEL NAME FOR CHANNEL_ID"/>
-  <meta-data  android:name="com.dieam.reactnativepushnotification.notification_channel_description.[CHANNEL_ID]"
-              android:value="YOUR NOTIFICATION CHANNEL DESCRIPTION FOR CHANNEL_ID"/>
-```
-
-For example:
-
-```xml
-  <meta-data  android:name="com.dieam.reactnativepushnotification.notification_channel_name.rn-push-notification-channel-id-4-300"
-          android:value="YOUR NOTIFICATION CHANNEL NAME FOR SILENT CHANNEL"/>
-  <meta-data  android:name="com.dieam.reactnativepushnotification.notification_channel_description.rn-push-notification-channel-id-4-300"
-              android:value="YOUR NOTIFICATION CHANNEL DESCRIPTION FOR SILENT CHANNEL"/>
-```
+In the notifications options, you must provide a channel id with `channelId: "your-channel-id"`, if the channel doesn't exist the notification might not e triggered. Once the channel is created, the channel cannot be update. Make sure your `channelId` is different if you change these options. If you have created a channel in another way, it will apply options of the channel.
 
 If you want to use a different default channel for remote notification, refer to the documentation of Firebase:
 

android/src/main/java/com/dieam/reactnativepushnotification/modules/RNPushNotification.java

@@ -57,12 +57,8 @@ public RNPushNotification(ReactApplicationContext reactContext) {
         mRNPushNotificationHelper = new RNPushNotificationHelper(applicationContext);
         // This is used to delivery callbacks to JS
         mJsDelivery = new RNPushNotificationJsDelivery(reactContext);
-
-        mRNPushNotificationHelper.checkOrCreateDefaultChannel();
     }
 
-
-
     @Override
     public String getName() {
         return "RNPushNotification";

android/src/main/java/com/dieam/reactnativepushnotification/modules/RNPushNotificationAttributes.java

@@ -28,8 +28,6 @@ public class RNPushNotificationAttributes {
     private static final String BIG_PICTURE_URL = "bigPictureUrl";
     private static final String SHORTCUT_ID = "shortcutId";
     private static final String CHANNEL_ID = "channelId";
-    private static final String CHANNEL_NAME = "channelName";
-    private static final String CHANNEL_DESCRIPTION = "channelDescription";
     private static final String NUMBER = "number";
     private static final String SOUND = "sound";
     private static final String COLOR = "color";
@@ -68,8 +66,6 @@ public class RNPushNotificationAttributes {
     private final String shortcutId;
     private final String number;
     private final String channelId;
-    private final String channelName;
-    private final String channelDescription;
     private final String sound;
     private final String color;
     private final String group;
@@ -108,8 +104,6 @@ public RNPushNotificationAttributes(Bundle bundle) {
         shortcutId = bundle.getString(SHORTCUT_ID);
         number = bundle.getString(NUMBER);
         channelId = bundle.getString(CHANNEL_ID);
-        channelName = bundle.getString(CHANNEL_NAME);
-        channelDescription = bundle.getString(CHANNEL_DESCRIPTION);
         sound = bundle.getString(SOUND);
         color = bundle.getString(COLOR);
         group = bundle.getString(GROUP);
@@ -150,8 +144,6 @@ private RNPushNotificationAttributes(JSONObject jsonObject) {
             shortcutId = jsonObject.has(SHORTCUT_ID) ? jsonObject.getString(SHORTCUT_ID) : null;
             number = jsonObject.has(NUMBER) ? jsonObject.getString(NUMBER) : null;
             channelId = jsonObject.has(CHANNEL_ID) ? jsonObject.getString(CHANNEL_ID) : null;
-            channelName = jsonObject.has(CHANNEL_NAME) ? jsonObject.getString(CHANNEL_NAME) : null;
-            channelDescription = jsonObject.has(CHANNEL_DESCRIPTION) ? jsonObject.getString(CHANNEL_DESCRIPTION) : null;
             sound = jsonObject.has(SOUND) ? jsonObject.getString(SOUND) : null;
             color = jsonObject.has(COLOR) ? jsonObject.getString(COLOR) : null;
             group = jsonObject.has(GROUP) ? jsonObject.getString(GROUP) : null;
@@ -249,8 +241,6 @@ public Bundle toBundle() {
         bundle.putString(SHORTCUT_ID, shortcutId);
         bundle.putString(NUMBER, number);
         bundle.putString(CHANNEL_ID, channelId);
-        bundle.putString(CHANNEL_NAME, channelName);
-        bundle.putString(CHANNEL_DESCRIPTION, channelDescription);
         bundle.putString(SOUND, sound);
         bundle.putString(COLOR, color);
         bundle.putString(GROUP, group);
@@ -293,8 +283,6 @@ public JSONObject toJson() {
             jsonObject.put(SHORTCUT_ID, shortcutId);
             jsonObject.put(NUMBER, number);
             jsonObject.put(CHANNEL_ID, channelId);
-            jsonObject.put(CHANNEL_NAME, channelName);
-            jsonObject.put(CHANNEL_DESCRIPTION, channelDescription);
             jsonObject.put(SOUND, sound);
             jsonObject.put(COLOR, color);
             jsonObject.put(GROUP, group);
@@ -343,8 +331,6 @@ public String toString() {
                 ", shortcutId='" + shortcutId + '\'' +
                 ", number='" + number + '\'' +
                 ", channelId='" + channelId + '\'' +
-                ", channelName='" + channelId + '\'' +
-                ", channelDescription='" + channelDescription + '\'' +
                 ", sound='" + sound + '\'' +
                 ", color='" + color + '\'' +
                 ", group='" + group + '\'' +

android/src/main/java/com/dieam/reactnativepushnotification/modules/RNPushNotificationBootEventReceiver.java

@@ -20,32 +20,30 @@ public class RNPushNotificationBootEventReceiver extends BroadcastReceiver {
     public void onReceive(Context context, Intent intent) {
         Log.i(LOG_TAG, "RNPushNotificationBootEventReceiver loading scheduled notifications");
 
-        if ("android.intent.action.BOOT_COMPLETED".equals(intent.getAction())) {
-            SharedPreferences sharedPreferences = context.getSharedPreferences(RNPushNotificationHelper.PREFERENCES_KEY, Context.MODE_PRIVATE);
-            Set<String> ids = sharedPreferences.getAll().keySet();
-
-            Application applicationContext = (Application) context.getApplicationContext();
-            RNPushNotificationHelper rnPushNotificationHelper = new RNPushNotificationHelper(applicationContext);
-
-            for (String id : ids) {
-                try {
-                    String notificationAttributesJson = sharedPreferences.getString(id, null);
-                    if (notificationAttributesJson != null) {
-                        RNPushNotificationAttributes notificationAttributes = RNPushNotificationAttributes.fromJson(notificationAttributesJson);
-
-                        if (notificationAttributes.getFireDate() < System.currentTimeMillis()) {
-                            Log.i(LOG_TAG, "RNPushNotificationBootEventReceiver: Showing notification for " +
-                                    notificationAttributes.getId());
-                            rnPushNotificationHelper.sendToNotificationCentre(notificationAttributes.toBundle());
-                        } else {
-                            Log.i(LOG_TAG, "RNPushNotificationBootEventReceiver: Scheduling notification for " +
-                                    notificationAttributes.getId());
-                            rnPushNotificationHelper.sendNotificationScheduledCore(notificationAttributes.toBundle());
-                        }
+        SharedPreferences sharedPreferences = context.getSharedPreferences(RNPushNotificationHelper.PREFERENCES_KEY, Context.MODE_PRIVATE);
+        Set<String> ids = sharedPreferences.getAll().keySet();
+
+        Application applicationContext = (Application) context.getApplicationContext();
+        RNPushNotificationHelper rnPushNotificationHelper = new RNPushNotificationHelper(applicationContext);
+
+        for (String id : ids) {
+            try {
+                String notificationAttributesJson = sharedPreferences.getString(id, null);
+                if (notificationAttributesJson != null) {
+                    RNPushNotificationAttributes notificationAttributes = RNPushNotificationAttributes.fromJson(notificationAttributesJson);
+
+                    if (notificationAttributes.getFireDate() < System.currentTimeMillis()) {
+                        Log.i(LOG_TAG, "RNPushNotificationBootEventReceiver: Showing notification for " +
+                                notificationAttributes.getId());
+                        rnPushNotificationHelper.sendToNotificationCentre(notificationAttributes.toBundle());
+                    } else {
+                        Log.i(LOG_TAG, "RNPushNotificationBootEventReceiver: Scheduling notification for " +
+                                notificationAttributes.getId());
+                        rnPushNotificationHelper.sendNotificationScheduledCore(notificationAttributes.toBundle());
                     }
-                } catch (Exception e) {
-                    Log.e(LOG_TAG, "Problem with boot receiver loading notification " + id, e);
                 }
+            } catch (Exception e) {
+                Log.e(LOG_TAG, "Problem with boot receiver loading notification " + id, e);
             }
         }
     }