Supported setting channel's name.

phongcao · phongcao · commit 0cdf7106eb4e · 2020-03-14T17:34:56.000-04:00
diff --git a/android/src/main/java/com/azure/reactnative/notificationhub/ReactNativeConstants.java b/android/src/main/java/com/azure/reactnative/notificationhub/ReactNativeConstants.java
@@ -10,6 +10,13 @@ public final class ReactNativeConstants {
     public static final String EVENT_AZURE_NOTIFICATION_HUB_REGISTERED = "azureNotificationHubRegistered";
     public static final String EVENT_AZURE_NOTIFICATION_HUB_REGISTERED_ERROR = "azureNotificationHubRegisteredError";
 
+    // Registration's keys
+    public static final String KEY_REGISTRATION_CHANNELNAME = "channelName";
+    public static final String KEY_REGISTRATION_CHANNELIMPORTANCE = "channelImportance";
+    public static final String KEY_REGISTRATION_CHANNELSHOWBADGE = "channelShowBadge";
+    public static final String KEY_REGISTRATION_CHANNELENABLELIGHTS = "channelEnableLights";
+    public static final String KEY_REGISTRATION_CHANNELENABLEVIBRATION = "channelEnableVibration";
+
     // Shared prefs used in NotificationHubUtil
     public static final String SHARED_PREFS_NAME = "com.azure.reactnative.notificationhub.NotificationHubUtil";
     public static final String KEY_FOR_PREFS_REGISTRATIONID = "AzureNotificationHub_registrationID";
@@ -18,6 +25,7 @@ public final class ReactNativeConstants {
     public static final String KEY_FOR_PREFS_FCMTOKEN = "AzureNotificationHub_FCMToken";
     public static final String KEY_FOR_PREFS_TAGS = "AzureNotificationHub_Tags";
     public static final String KEY_FOR_PREFS_SENDERID = "AzureNotificationHub_senderID";
+    public static final String KEY_FOR_PREFS_CHANNELNAME = "AzureNotificationHub_channelName";
     public static final String KEY_FOR_PREFS_CHANNELIMPORTANCE = "AzureNotificationHub_channelImportance";
     public static final String KEY_FOR_PREFS_CHANNELSHOWBADGE = "AzureNotificationHub_channelShowBadge";
     public static final String KEY_FOR_PREFS_CHANNELENABLELIGHTS = "AzureNotificationHub_channelEnableLights";
diff --git a/android/src/main/java/com/azure/reactnative/notificationhub/ReactNativeFirebaseMessagingService.java b/android/src/main/java/com/azure/reactnative/notificationhub/ReactNativeFirebaseMessagingService.java
@@ -23,6 +23,11 @@ public static void createNotificationChannel(Context context) {
         if (notificationChannelID == null) {
             ReactNativeNotificationHubUtil notificationHubUtil = ReactNativeNotificationHubUtil.getInstance();
             ReactNativeNotificationChannelBuilder builder = ReactNativeNotificationChannelBuilder.Factory.create();
+
+            if (notificationHubUtil.hasChannelName(context)) {
+                builder.setName(notificationHubUtil.getChannelName(context));
+            }
+
             if (notificationHubUtil.hasChannelImportance(context)) {
                 builder.setImportance(notificationHubUtil.getChannelImportance(context));
             }
diff --git a/android/src/main/java/com/azure/reactnative/notificationhub/ReactNativeNotificationHubModule.java b/android/src/main/java/com/azure/reactnative/notificationhub/ReactNativeNotificationHubModule.java
@@ -97,23 +97,28 @@ public void register(ReadableMap config, Promise promise) {
         notificationHubUtil.setSenderID(reactContext, senderID);
         notificationHubUtil.setTags(reactContext, tags);
 
-        if (config.hasKey("channelImportance")) {
-            int channelImportance = config.getInt("channelImportance");
+        if (config.hasKey(KEY_REGISTRATION_CHANNELNAME)) {
+            String channelName = config.getString(KEY_REGISTRATION_CHANNELNAME);
+            notificationHubUtil.setChannelName(reactContext, channelName);
+        }
+
+        if (config.hasKey(KEY_REGISTRATION_CHANNELIMPORTANCE)) {
+            int channelImportance = config.getInt(KEY_REGISTRATION_CHANNELIMPORTANCE);
             notificationHubUtil.setChannelImportance(reactContext, channelImportance);
         }
 
-        if (config.hasKey("channelShowBadge")) {
-            boolean channelShowBadge = config.getBoolean("channelShowBadge");
+        if (config.hasKey(KEY_REGISTRATION_CHANNELSHOWBADGE)) {
+            boolean channelShowBadge = config.getBoolean(KEY_REGISTRATION_CHANNELSHOWBADGE);
             notificationHubUtil.setChannelShowBadge(reactContext, channelShowBadge);
         }
 
-        if (config.hasKey("channelEnableLights")) {
-            boolean channelEnableLights = config.getBoolean("channelEnableLights");
+        if (config.hasKey(KEY_REGISTRATION_CHANNELENABLELIGHTS)) {
+            boolean channelEnableLights = config.getBoolean(KEY_REGISTRATION_CHANNELENABLELIGHTS);
             notificationHubUtil.setChannelEnableLights(reactContext, channelEnableLights);
         }
 
-        if (config.hasKey("channelEnableVibration")) {
-            boolean channelEnableVibration = config.getBoolean("channelEnableVibration");
+        if (config.hasKey(KEY_REGISTRATION_CHANNELENABLEVIBRATION)) {
+            boolean channelEnableVibration = config.getBoolean(KEY_REGISTRATION_CHANNELENABLEVIBRATION);
             notificationHubUtil.setChannelEnableVibration(reactContext, channelEnableVibration);
         }
 
diff --git a/android/src/main/java/com/azure/reactnative/notificationhub/ReactNativeNotificationHubUtil.java b/android/src/main/java/com/azure/reactnative/notificationhub/ReactNativeNotificationHubUtil.java
@@ -105,6 +105,18 @@ public void setSenderID(Context context, String senderID) {
         setPref(context, KEY_FOR_PREFS_SENDERID, senderID);
     }
 
+    public String getChannelName(Context context) {
+        return getPref(context, KEY_FOR_PREFS_CHANNELNAME);
+    }
+
+    public void setChannelName(Context context, String channelName) {
+        setPref(context, KEY_FOR_PREFS_CHANNELNAME, channelName);
+    }
+
+    public boolean hasChannelName(Context context) {
+        return hasKey(context, KEY_FOR_PREFS_CHANNELNAME);
+    }
+
     public int getChannelImportance(Context context) {
         return getPrefInt(context, KEY_FOR_PREFS_CHANNELIMPORTANCE);
     }
diff --git a/docs/android-installation.md b/docs/android-installation.md
@@ -189,6 +189,7 @@ const connectionString = '...';       // The Notification Hub connection string
 const hubName = '...';                // The Notification Hub name
 const senderID = '...';               // The Sender ID from the Cloud Messaging tab of the Firebase console
 const tags = [ ... ];                 // The set of tags to subscribe to
+const channelName = '...';            // The channel's name
 const channelImportance = 3;          // The channel's importance (NotificationManager.IMPORTANCE_DEFAULT = 3)
                                       // Notes:
                                       //   1. Setting this value to 4 enables heads-up notification on Android 8
@@ -213,6 +214,7 @@ export default class App extends Component {
       hubName,
       senderID,
       tags,
+      channelName,
       channelImportance,
       channelShowBadge,
       channelEnableLights,
diff --git a/sample/android/app/src/test/java/com/reactnativeazurenotificationhubsample/ReactNativeFirebaseMessagingServiceTest.java b/sample/android/app/src/test/java/com/reactnativeazurenotificationhubsample/ReactNativeFirebaseMessagingServiceTest.java
@@ -30,6 +30,7 @@
 import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.anyBoolean;
 import static org.mockito.ArgumentMatchers.anyInt;
+import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.reset;
 import static org.mockito.Mockito.times;
@@ -99,6 +100,7 @@ public void testCreateNotificationChannelBelowVersionO() {
 
         ReactNativeNotificationChannelBuilder builder = PowerMockito.mock(ReactNativeNotificationChannelBuilder.class);
         when(ReactNativeNotificationChannelBuilder.Factory.create()).thenReturn(builder);
+        when(mHubUtil.hasChannelName(mReactApplicationContext)).thenReturn(false);
         when(mHubUtil.hasChannelImportance(mReactApplicationContext)).thenReturn(false);
         when(mHubUtil.hasChannelShowBadge(mReactApplicationContext)).thenReturn(false);
         when(mHubUtil.hasChannelEnableLights(mReactApplicationContext)).thenReturn(false);
@@ -107,6 +109,7 @@ public void testCreateNotificationChannelBelowVersionO() {
 
         ReactNativeFirebaseMessagingService.createNotificationChannel(mReactApplicationContext);
 
+        verify(builder, times(0)).setName(anyString());
         verify(builder, times(0)).setImportance(anyInt());
         verify(builder, times(0)).setShowBadge(anyBoolean());
         verify(builder, times(0)).enableLights(anyBoolean());
@@ -118,6 +121,7 @@ public void testCreateNotificationChannelBelowVersionO() {
 
     @Test
     public void testCreateNotificationChannel() {
+        final String channelName = "Channel Name";
         final int channelImportance = 1;
         final boolean channelShowBadge = true;
         final boolean channelEnableLights = true;
@@ -129,6 +133,8 @@ public void testCreateNotificationChannel() {
         NotificationChannel channel = PowerMockito.mock(NotificationChannel.class);
         when(channel.getId()).thenReturn(NOTIFICATION_CHANNEL_ID);
         when(builder.build()).thenReturn(channel);
+        when(mHubUtil.hasChannelName(mReactApplicationContext)).thenReturn(true);
+        when(mHubUtil.getChannelName(mReactApplicationContext)).thenReturn(channelName);
         when(mHubUtil.hasChannelImportance(mReactApplicationContext)).thenReturn(true);
         when(mHubUtil.getChannelImportance(mReactApplicationContext)).thenReturn(channelImportance);
         when(mHubUtil.hasChannelShowBadge(mReactApplicationContext)).thenReturn(true);
@@ -141,6 +147,8 @@ public void testCreateNotificationChannel() {
 
         ReactNativeFirebaseMessagingService.createNotificationChannel(mReactApplicationContext);
 
+        verify(mHubUtil, times(1)).hasChannelName(mReactApplicationContext);
+        verify(builder, times(1)).setName(channelName);
         verify(mHubUtil, times(1)).hasChannelImportance(mReactApplicationContext);
         verify(builder, times(1)).setImportance(channelImportance);
         verify(mHubUtil, times(1)).hasChannelShowBadge(mReactApplicationContext);
diff --git a/sample/android/app/src/test/java/com/reactnativeazurenotificationhubsample/ReactNativeNotificationHubModuleTest.java b/sample/android/app/src/test/java/com/reactnativeazurenotificationhubsample/ReactNativeNotificationHubModuleTest.java
@@ -172,6 +172,22 @@ public void testRegisterMissingSenderID() {
                 ERROR_INVALID_SENDER_ID);
     }
 
+    @Test
+    public void testRegisterHasChannelName() {
+        final String channelName = "Channel Name";
+
+        when(mConfig.getString("connectionString")).thenReturn("connectionString");
+        when(mConfig.getString("hubName")).thenReturn("hubName");
+        when(mConfig.getString("senderID")).thenReturn("senderID");
+        when(mConfig.hasKey(KEY_REGISTRATION_CHANNELNAME)).thenReturn(true);
+        when(mConfig.getString(KEY_REGISTRATION_CHANNELNAME)).thenReturn(channelName);
+
+        mHubModule.register(mConfig, mPromise);
+
+        verify(mNotificationHubUtil, times(1)).setChannelName(
+                any(ReactContext.class), eq(channelName));
+    }
+
     @Test
     public void testRegisterHasChannelImportance() {
         final int channelImportance = 1;
diff --git a/sample/android/app/src/test/java/com/reactnativeazurenotificationhubsample/ReactNativeNotificationHubUtilTest.java b/sample/android/app/src/test/java/com/reactnativeazurenotificationhubsample/ReactNativeNotificationHubUtilTest.java
@@ -194,6 +194,32 @@ public void testSetSenderID() {
         verify(mEditor, times(1)).apply();
     }
 
+    @Test
+    public void testGetChannelName() {
+        mHubUtil.getChannelName(mReactApplicationContext);
+
+        verify(mSharedPreferences, times(1)).getString(
+                KEY_FOR_PREFS_CHANNELNAME, null);
+    }
+
+    @Test
+    public void testSetChannelName() {
+        final String channelName = "Channel Name";
+
+        mHubUtil.setChannelName(mReactApplicationContext, channelName);
+
+        verify(mEditor, times(1)).putString(
+                KEY_FOR_PREFS_CHANNELNAME, channelName);
+        verify(mEditor, times(1)).apply();
+    }
+
+    @Test
+    public void testHasChannelName() {
+        mHubUtil.hasChannelName(mReactApplicationContext);
+
+        verify(mSharedPreferences, times(1)).contains(KEY_FOR_PREFS_CHANNELNAME);
+    }
+
     @Test
     public void testGetChannelImportance() {
         mHubUtil.getChannelImportance(mReactApplicationContext);
