Merge pull request #912 from Danziger/master

Allows disabling automatic notification creation and always showing notifications when in foreground

Author: EddyVerbruggen

docs/MESSAGING.md

@@ -110,6 +110,34 @@ Similarly to the message callback you can either wire this through `init` or as
   );
 ```
 
+### Disable automatic notification creation
+
+By default, this plugin will display a notification every time it receives one. If you want to disable this
+behaviour and handle the notifications yourself on the `onMessageReceivedCallback`, you need to set the
+`displayNotifications` option to `false`:
+
+```js
+firebase.init({
+  displayNotifications: false,
+});
+```
+
+You can display or schedule notifications yourself using the plugin [`nativescript-local-notifications`](https://github.com/EddyVerbruggen/nativescript-local-notifications).
+
+This might be helpful too if you or some other plugin you use is already setting the current notification center
+`delegate` property, as in that case adding another plugin that does that would result in a conflict.
+
+### Always show notifications when the application is in foreground
+
+If you always want to display notifications while the application is in foreground withouth sending additional
+parameters/data when sending the push notification, you need to set the `showWhenInForeground` option to `true`:
+
+```js
+firebase.init({
+  showWhenInForeground: true,
+});
+```
+
 ### Send messages to Topics
 Based on the publish/subscribe model, FCM topic messaging allows you to send a message to multiple devices that have opted in to a particular topic. You compose topic messages as needed, and FCM handles routing and delivering the message reliably to the right devices.
 

src/messaging/messaging.ios.ts

@@ -20,12 +20,17 @@ let _registerForRemoteNotificationsRanThisSession = false;
 let _userNotificationCenterDelegate: UNUserNotificationCenterDelegateImpl;
 let _messagingConnected: boolean = null;
 let _firebaseRemoteMessageDelegate: FIRMessagingDelegateImpl;
+let _displayNotifications: boolean = true;
+let _showWhenInForeground: boolean = false;
 
 // 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.
 const NOTIFICATIONS_REGISTRATION_KEY = "Firebase-RegisterForRemoteNotifications";
 
 export function initFirebaseMessaging(arg) {
+  _displayNotifications = arg.displayNotifications === undefined ? _displayNotifications : !!arg.displayNotifications;
+  _showWhenInForeground = arg.showWhenInForeground === undefined ? _showWhenInForeground : !!arg.showWhenInForeground;
+
   if (arg.onMessageReceivedCallback !== undefined || arg.onPushTokenReceivedCallback !== undefined) {
     if (arg.onMessageReceivedCallback !== undefined) {
       addOnMessageReceivedCallback(arg.onMessageReceivedCallback);
@@ -388,33 +393,35 @@ function _registerForRemoteNotifications() {
       }
     });
 
-    _userNotificationCenterDelegate = UNUserNotificationCenterDelegateImpl.new().initWithCallback((unnotification, actionIdentifier?, inputText?) => {
-      // if the app is in the foreground then this method will receive the notification
-      // if the app is in the background, and user has responded to interactive notification, then this method will receive the notification
-      // if the app is in the background, and user views a notification, applicationDidReceiveRemoteNotificationFetchCompletionHandler will receive it
-      const userInfo = unnotification.request.content.userInfo;
-      const userInfoJSON = firebaseUtils.toJsObject(userInfo);
-      updateUserInfo(userInfoJSON);
-
-      if (actionIdentifier) {
-        _pendingActionTakenNotifications.push({
-          actionIdentifier,
-          userInfoJSON,
-          inputText
-        });
-        if (_notificationActionTakenCallback) {
-          _processPendingActionTakenNotifications();
+    if (_displayNotifications) {
+      _userNotificationCenterDelegate = UNUserNotificationCenterDelegateImpl.new().initWithCallback((unnotification, actionIdentifier?, inputText?) => {
+        // if the app is in the foreground then this method will receive the notification
+        // if the app is in the background, and user has responded to interactive notification, then this method will receive the notification
+        // if the app is in the background, and user views a notification, applicationDidReceiveRemoteNotificationFetchCompletionHandler will receive it
+        const userInfo = unnotification.request.content.userInfo;
+        const userInfoJSON = firebaseUtils.toJsObject(userInfo);
+        updateUserInfo(userInfoJSON);
+
+        if (actionIdentifier) {
+          _pendingActionTakenNotifications.push({
+            actionIdentifier,
+            userInfoJSON,
+            inputText
+          });
+          if (_notificationActionTakenCallback) {
+            _processPendingActionTakenNotifications();
+          }
         }
-      }
 
-      userInfoJSON.foreground = true;
-      _pendingNotifications.push(userInfoJSON);
-      if (_receivedNotificationCallback) {
-        _processPendingNotifications();
-      }
-    });
+        userInfoJSON.foreground = true;
+        _pendingNotifications.push(userInfoJSON);
+        if (_receivedNotificationCallback) {
+          _processPendingNotifications();
+        }
+      });
 
-    curNotCenter.delegate = _userNotificationCenterDelegate;
+      curNotCenter.delegate = _userNotificationCenterDelegate;
+    }
 
     if (typeof (FIRMessaging) !== "undefined") {
       _firebaseRemoteMessageDelegate = FIRMessagingDelegateImpl.new().initWithCallback((appDataDictionary: NSDictionary<any, any>) => {
@@ -544,9 +551,10 @@ class UNUserNotificationCenterDelegateImpl extends NSObject implements UNUserNot
     const userInfo = notification.request.content.userInfo;
     const userInfoJSON = firebaseUtils.toJsObject(userInfo);
 
-    if (userInfoJSON["gcm.notification.showWhenInForeground"] === "true" || // this is for FCM
-        userInfoJSON["showWhenInForeground"] === true || // this is for non-FCM,
-        (userInfoJSON.aps && userInfoJSON.aps.showWhenInForeground === true) // and this as well (so users can choose where to put it)
+    if ( _showWhenInForeground || // Default value, in case we always want to show when in foreground.
+      userInfoJSON["gcm.notification.showWhenInForeground"] === "true" || // This is for FCM, ...
+      userInfoJSON["showWhenInForeground"] === true || // ...this is for non-FCM...
+      (userInfoJSON.aps && userInfoJSON.aps.showWhenInForeground === true) // ...and this as well (so users can choose where to put it).
     ) {
       // don't invoke the callback here, since the app shouldn't fi. navigate to a new page unless the user pressed the notification
       completionHandler(UNNotificationPresentationOptions.Alert | UNNotificationPresentationOptions.Sound | UNNotificationPresentationOptions.Badge);

src/scripts/postinstall.js

@@ -2730,28 +2730,28 @@ function read (opts, cb) {
   \***********************************/
 /***/ (function(module, exports) {
 
-module.exports = function(module) {
-	if(!module.webpackPolyfill) {
-		module.deprecate = function() {};
-		module.paths = [];
-		// module.parent = undefined by default
-		if(!module.children) module.children = [];
-		Object.defineProperty(module, "loaded", {
-			enumerable: true,
-			get: function() {
-				return module.l;
-			}
-		});
-		Object.defineProperty(module, "id", {
-			enumerable: true,
-			get: function() {
-				return module.i;
-			}
-		});
-		module.webpackPolyfill = 1;
-	}
-	return module;
-};
+module.exports = function(module) {
+	if(!module.webpackPolyfill) {
+		module.deprecate = function() {};
+		module.paths = [];
+		// module.parent = undefined by default
+		if(!module.children) module.children = [];
+		Object.defineProperty(module, "loaded", {
+			enumerable: true,
+			get: function() {
+				return module.l;
+			}
+		});
+		Object.defineProperty(module, "id", {
+			enumerable: true,
+			get: function() {
+				return module.i;
+			}
+		});
+		module.webpackPolyfill = 1;
+	}
+	return module;
+};
 
 
 /***/ }),