Merge pull request #1235 from gogoout/feature/auto-clear-badge

feat(message) add flag to disable the auto clearing badge

Author: EddyVerbruggen

docs/MESSAGING.md

@@ -175,7 +175,7 @@ curl -X POST --header "Authorization: key=SERVER_KEY" --Header "Content-Type: ap
 
 <img src="images/push-server-key.png" width="459px" height="220px" alt="Push server key"/>
 
-> Note that if you don't want a badge on the app icon, remove the `badge` property or set it to 0. Note that launching the app clears the badge anyway.
+> Note that if you don't want a badge on the app icon, remove the `badge` property or set it to 0. 
 
 ### Notfication-popup example
 
@@ -303,6 +303,15 @@ Add the `showWhenInForeground` flag to your payload:
 }
 ```
 
+### (iOS) Disable automatic clearing the badge
+Currently by default, when launching the app, badge is cleared. You can disable the feature by passing a flag in your init option.
+
+```js
+firebase.init({
+  autoClearBadge: false
+});
+```
+
 ## What if iOS doesn't show/receive notifications in the background?
 Make sure you [`require` the plugin in `app.ts` / `main.ts` / `main.aot.ts`](https://github.com/EddyVerbruggen/nativescript-plugin-firebase/blob/55cfb4f69cf8939f9101712fed22383196b08d36/demo/app/app.ts#L5)
 *before* `application.start()`, and do `init()` *after* the app has started (not in `app.ts` - not even in a timeout; move it out of `app.ts` entirely!).

src/firebase.d.ts

@@ -107,6 +107,12 @@ export interface MessagingOptions {
    * Currently used on iOS only. Default false.
    */
   showNotificationsWhenInForeground?: boolean;
+
+  /**
+   * Automatically clear the badges on starting.
+   * Currently used on iOS only. Default true.
+   */
+  autoClearBadge?:boolean;
 }
 
 /**

src/messaging/messaging.ios.ts

@@ -23,6 +23,7 @@ let _messagingConnected: boolean = null;
 let _firebaseRemoteMessageDelegate: FIRMessagingDelegateImpl;
 let _showNotifications: boolean = true;
 let _showNotificationsWhenInForeground: boolean = false;
+let _autoClearBadge: boolean = true;
 
 // Track whether or not registration for remote notifications was request.
 // This way we can suppress the "Allow notifications" consent popup until the listeners are passed in.
@@ -34,6 +35,7 @@ export function initFirebaseMessaging(options) {
   }
   _showNotifications = options.showNotifications === undefined ? _showNotifications : !!options.showNotifications;
   _showNotificationsWhenInForeground = options.showNotificationsWhenInForeground === undefined ? _showNotificationsWhenInForeground : !!options.showNotificationsWhenInForeground;
+  _autoClearBadge = options.autoClearBadge === undefined ? _autoClearBadge : !!options.autoClearBadge;
 
   if (options.onMessageReceivedCallback !== undefined) {
     addOnMessageReceivedCallback(options.onMessageReceivedCallback);
@@ -516,7 +518,7 @@ function _processPendingNotifications() {
     }
     _pendingNotifications = [];
 
-    if (app.applicationState === UIApplicationState.Active) {
+    if (app.applicationState === UIApplicationState.Active && _autoClearBadge) {
       app.applicationIconBadgeNumber = 0;
     }
   }
@@ -534,7 +536,7 @@ function _processPendingActionTakenNotifications() {
     }
     _pendingActionTakenNotifications = [];
 
-    if (app.applicationState === UIApplicationState.Active) {
+    if (app.applicationState === UIApplicationState.Active && _autoClearBadge) {
       app.applicationIconBadgeNumber = 0;
     }
   }