feat(messaging, apple): allow system to display button for in-app notification settings (#13484)

Co-authored-by: Russell Wheatley <[email protected]>

Author: StanleyCocos

packages/firebase_messaging/firebase_messaging/example/lib/permissions.dart

@@ -57,9 +57,13 @@ class _Permissions extends State<Permissions> {
     return Container(
       margin: const EdgeInsets.only(bottom: 8),
       child: Row(
-        mainAxisAlignment: MainAxisAlignment.spaceBetween,
         children: [
-          Text('$title:', style: const TextStyle(fontWeight: FontWeight.bold)),
+          Expanded(
+            child: Text(
+              '$title:',
+              style: const TextStyle(fontWeight: FontWeight.bold),
+            ),
+          ),
           Text(value),
         ],
       ),
@@ -89,6 +93,8 @@ class _Permissions extends State<Permissions> {
         row('Notification Center', settingsMap[_settings.notificationCenter]!),
         row('Show Previews', previewMap[_settings.showPreviews]!),
         row('Sound', settingsMap[_settings.sound]!),
+        row('Provides App Notification Settings',
+            settingsMap[_settings.providesAppNotificationSettings]!),
       ],
       ElevatedButton(
           onPressed: checkPermissions, child: const Text('Reload Permissions')),

packages/firebase_messaging/firebase_messaging/ios/firebase_messaging/Sources/firebase_messaging/FLTFirebaseMessagingPlugin.m

@@ -612,6 +612,12 @@ - (void)messagingRequestPermission:(id)arguments
     }
   }
 
+  if ([permissions[@"providesAppNotificationSettings"] isEqual:@(YES)]) {
+    if (@available(iOS 12.0, *)) {
+      options |= UNAuthorizationOptionProvidesAppNotificationSettings;
+    }
+  }
+
   id handler = ^(BOOL granted, NSError *_Nullable error) {
     if (error != nil) {
       result.error(nil, nil, nil, error);
@@ -784,6 +790,15 @@ + (NSDictionary *)NSDictionaryFromUNNotificationSettings:(UNNotificationSettings
       NSNumberForUNNotificationSetting:settings.notificationCenterSetting];
   settingsDictionary[@"timeSensitive"] = timeSensitive;
 
+  if (@available(iOS 12.0, *)) {
+    if (settings.providesAppNotificationSettings) {
+      settingsDictionary[@"providesAppNotificationSettings"] = @1;
+    } else {
+      settingsDictionary[@"providesAppNotificationSettings"] = @0;
+    }
+  } else {
+    settingsDictionary[@"providesAppNotificationSettings"] = @-1;
+  }
   return settingsDictionary;
 }
 

packages/firebase_messaging/firebase_messaging/lib/src/messaging.dart

@@ -193,6 +193,12 @@ class FirebaseMessaging extends FirebasePluginPlatform {
     ///
     /// iOS/macOS only.
     bool sound = true,
+
+    /// Request permission for an option indicating the system should display a button for in-app notification settings.
+    /// Defaults to `false`.
+    ///
+    /// iOS/macOS only.
+    bool providesAppNotificationSettings = false,
   }) {
     return _delegate.requestPermission(
       alert: alert,
@@ -202,6 +208,7 @@ class FirebaseMessaging extends FirebasePluginPlatform {
       criticalAlert: criticalAlert,
       provisional: provisional,
       sound: sound,
+      providesAppNotificationSettings: providesAppNotificationSettings,
     );
   }
 

packages/firebase_messaging/firebase_messaging/test/firebase_messaging_test.dart

@@ -132,57 +132,69 @@ void main() {
           criticalAlert: anyNamed('criticalAlert'),
           provisional: anyNamed('provisional'),
           sound: anyNamed('sound'),
+          providesAppNotificationSettings:
+              anyNamed('providesAppNotificationSettings'),
         )).thenAnswer((_) => Future.value(defaultNotificationSettings));
 
         // true values
         await messaging!.requestPermission(
-            alert: true,
-            announcement: true,
-            badge: true,
-            carPlay: true,
-            criticalAlert: true,
-            provisional: true,
-            sound: true);
+          alert: true,
+          announcement: true,
+          badge: true,
+          carPlay: true,
+          criticalAlert: true,
+          provisional: true,
+          sound: true,
+          providesAppNotificationSettings: true,
+        );
 
         verify(kMockMessagingPlatform.requestPermission(
-            alert: true,
-            announcement: true,
-            badge: true,
-            carPlay: true,
-            criticalAlert: true,
-            provisional: true,
-            sound: true));
+          alert: true,
+          announcement: true,
+          badge: true,
+          carPlay: true,
+          criticalAlert: true,
+          provisional: true,
+          sound: true,
+          providesAppNotificationSettings: true,
+        ));
 
         // false values
         await messaging!.requestPermission(
-            alert: false,
-            announcement: false,
-            badge: false,
-            carPlay: false,
-            criticalAlert: false,
-            provisional: false,
-            sound: false);
+          alert: false,
+          announcement: false,
+          badge: false,
+          carPlay: false,
+          criticalAlert: false,
+          provisional: false,
+          sound: false,
+          providesAppNotificationSettings: false,
+        );
 
         verify(kMockMessagingPlatform.requestPermission(
-            alert: false,
-            announcement: false,
-            badge: false,
-            carPlay: false,
-            criticalAlert: false,
-            provisional: false,
-            sound: false));
+          alert: false,
+          announcement: false,
+          badge: false,
+          carPlay: false,
+          criticalAlert: false,
+          provisional: false,
+          sound: false,
+          providesAppNotificationSettings: false,
+        ));
 
         // default values
         await messaging!.requestPermission();
 
         verify(kMockMessagingPlatform.requestPermission(
-            alert: true,
-            announcement: false,
-            badge: true,
-            carPlay: false,
-            criticalAlert: false,
-            provisional: false,
-            sound: true));
+          alert: true,
+          announcement: false,
+          badge: true,
+          carPlay: false,
+          criticalAlert: false,
+          provisional: false,
+          sound: true,
+          providesAppNotificationSettings: false,
+        ));
       });
     });
 

packages/firebase_messaging/firebase_messaging/test/mock.dart

@@ -120,14 +120,16 @@ class MockFirebaseMessaging extends Mock
   }
 
   @override
-  Future<NotificationSettings> requestPermission(
-      {bool? alert = true,
-      bool? announcement = false,
-      bool? badge = true,
-      bool? carPlay = false,
-      bool? criticalAlert = false,
-      bool? provisional = false,
-      bool? sound = true}) {
+  Future<NotificationSettings> requestPermission({
+    bool? alert = true,
+    bool? announcement = false,
+    bool? badge = true,
+    bool? carPlay = false,
+    bool? criticalAlert = false,
+    bool? provisional = false,
+    bool? sound = true,
+    bool? providesAppNotificationSettings = false,
+  }) {
     return super.noSuchMethod(
         Invocation.method(#requestPermission, [], {
           #alert: alert,
@@ -136,7 +138,8 @@ class MockFirebaseMessaging extends Mock
           #carPlay: carPlay,
           #criticalAlert: criticalAlert,
           #provisional: provisional,
-          #sound: sound
+          #sound: sound,
+          #providesAppNotificationSettings: providesAppNotificationSettings,
         }),
         returnValue: neverEndingFuture<NotificationSettings>(),
         returnValueForMissingStub: neverEndingFuture<NotificationSettings>());

packages/firebase_messaging/firebase_messaging_platform_interface/lib/src/method_channel/method_channel_messaging.dart

@@ -284,6 +284,7 @@ class MethodChannelFirebaseMessaging extends FirebaseMessagingPlatform {
     bool criticalAlert = false,
     bool provisional = false,
     bool sound = true,
+    bool providesAppNotificationSettings = false,
   }) async {
     if (defaultTargetPlatform != TargetPlatform.iOS &&
         defaultTargetPlatform != TargetPlatform.macOS &&
@@ -303,6 +304,7 @@ class MethodChannelFirebaseMessaging extends FirebaseMessagingPlatform {
           'criticalAlert': criticalAlert,
           'provisional': provisional,
           'sound': sound,
+          'providesAppNotificationSettings': providesAppNotificationSettings,
         }
       });
 

packages/firebase_messaging/firebase_messaging_platform_interface/lib/src/notification_settings.dart

@@ -8,18 +8,20 @@ import 'package:firebase_messaging_platform_interface/firebase_messaging_platfor
 /// Represents the devices notification settings.
 class NotificationSettings {
   // ignore: public_member_api_docs
-  const NotificationSettings(
-      {required this.alert,
-      required this.announcement,
-      required this.authorizationStatus,
-      required this.badge,
-      required this.carPlay,
-      required this.lockScreen,
-      required this.notificationCenter,
-      required this.showPreviews,
-      required this.timeSensitive,
-      required this.criticalAlert,
-      required this.sound});
+  const NotificationSettings({
+    required this.alert,
+    required this.announcement,
+    required this.authorizationStatus,
+    required this.badge,
+    required this.carPlay,
+    required this.lockScreen,
+    required this.notificationCenter,
+    required this.showPreviews,
+    required this.timeSensitive,
+    required this.criticalAlert,
+    required this.sound,
+    required this.providesAppNotificationSettings,
+  });
 
   /// Whether or not messages containing a notification will alert the user.
   ///
@@ -79,4 +81,9 @@ class NotificationSettings {
   ///
   /// Apple devices only.
   final AppleNotificationSetting sound;
+
+  /// Whether or not system displays an application notification settings button
+  ///
+  /// Apple devices only.
+  final AppleNotificationSetting providesAppNotificationSettings;
 }

packages/firebase_messaging/firebase_messaging_platform_interface/lib/src/platform_interface/platform_interface_messaging.dart

@@ -252,6 +252,12 @@ abstract class FirebaseMessagingPlatform extends PlatformInterface {
     ///
     /// iOS only.
     bool sound = true,
+
+    /// Request permission for an option indicating the system should display a button for in-app notification settings.
+    /// Defaults to `false`.
+    ///
+    /// iOS/macOS only.
+    bool providesAppNotificationSettings = false,
   }) {
     throw UnimplementedError('requestPermission() is not implemented');
   }

packages/firebase_messaging/firebase_messaging_platform_interface/lib/src/utils.dart

@@ -143,6 +143,8 @@ NotificationSettings convertToNotificationSettings(Map<String, int> map) {
         convertToAppleNotificationSetting(map['notificationCenter']),
     showPreviews: convertToAppleShowPreviewSetting(map['showPreviews']),
     sound: convertToAppleNotificationSetting(map['sound']),
+    providesAppNotificationSettings: convertToAppleNotificationSetting(
+        map['providesAppNotificationSettings']),
   );
 }
 
@@ -159,4 +161,5 @@ const NotificationSettings defaultNotificationSettings = NotificationSettings(
   sound: AppleNotificationSetting.notSupported,
   timeSensitive: AppleNotificationSetting.notSupported,
   criticalAlert: AppleNotificationSetting.notSupported,
+  providesAppNotificationSettings: AppleNotificationSetting.notSupported,
 );

packages/firebase_messaging/firebase_messaging_platform_interface/test/method_channel_tests/method_channel_messaging_test.dart

@@ -49,6 +49,7 @@ void main() {
               'criticalAlert': 0,
               'provisional': 0,
               'sound': 1,
+              'providesAppNotificationSettings': 0,
             };
           case 'Messaging#setAutoInitEnabled':
             return {
@@ -197,6 +198,7 @@ void main() {
               'criticalAlert': false,
               'provisional': false,
               'sound': true,
+              'providesAppNotificationSettings': false,
             }
           },
         ),