Skip to content

Commit 79242b4

Browse files
lukemmttMaikuB
lukemmtt
and
MaikuB
authored
[flutter_local_notifications] Add support for providesAppNotificationSettings (#2558)
* Add support for `providesAppNotificationSettings` * Apply suggestions from code review * Add providesAppNotificationSettings to iOS Example app * Apply suggestions from code review Co-authored-by: Michael Bui <25263378+MaikuB@users.noreply.github.com> * Update flutter_local_notifications/example/lib/main.dart * Extract the ConfigureInAppToggle widget * Fix dcm lints * Fix linting issues All linting checks pass with Flutter 3.22.0 (project minimum version). * Fixes macOS test: requests all settings * Removes redundant test Removes the redundant 'checkPermissions' tests. The existing 'checkPermissions' tests already cover the functionality. * Rename test description for clarity * Run dart format on test files Applied dart format to fix indentation. * Update iOS/macOS platform check Co-authored-by: Michael Bui <25263378+MaikuB@users.noreply.github.com> * Wrap ConfigureInAppToggle with iOS-only check The ConfigureInAppToggle widget should only appear on iOS, not macOS. This change wraps the widget with `if (Platform.isIOS)` so it's hidden on macOS while still being in the iOS/macOS shared examples section. Addresses MaikuB's review feedback. * Attempt to add providesAppNotificationSettings support for Macos Example app (doesn't work) This commit is a proof-of-concept in which I attempted to implement and demonstrate whether configuring this "Configure in App" API on macOS has any actual effect (like it does on iOS): I can confirm, it does *not*. Details: Even with these modifications and corresponding macOS AppDelegate configuration, no such "Configure in App" option was visible upon right-clicking the notification in the macOS notification pane, as tested on macOS Tahoe 26.0. Additionally, I could not find any examples on the web demonstrating this feature on macOS. As such, while macOS does support the providesAppNotificationSettings API (likely for API symmetry with iOS, and for potential future compatibility), at the moment, this API does not result in any user-facing UI/UX change on macOS. This commit will be reverted, but I'll preserve it in the branch as a record of the finding. * Revert "Attempt to add providesAppNotificationSettings support for Macos Example app (doesn't work)" This reverts commit 51f1e329bfa364023ab73144934a7638f1117af3. * Clarify macOS limitation in README and API docs Updates user-facing documentation to clarify that while providesAppNotificationSettings API is available on macOS 10.14+, the UI button does not appear in notification context menus in practice. The feature is fully functional on iOS 12+. --------- Co-authored-by: Michael Bui <25263378+MaikuB@users.noreply.github.com>
1 parent ecd66b1 commit 79242b4

13 files changed

Lines changed: 447 additions & 23 deletions

File tree

‎flutter_local_notifications/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,7 @@ Note: the plugin requires Flutter SDK 3.22 at a minimum. The list of support pla
102102
* [Android] Ability to check if notifications are enabled
103103
* [iOS (all supported versions) & macOS 10.14+] Request notification permissions and customise the permissions being requested around displaying notifications
104104
* [iOS 10 or newer and macOS 10.14 or newer] Display notifications with attachments
105+
* [iOS 12.0+] Support for custom notification settings UI via "Configure Notifications in <application name>" button in notification context menu (API available on macOS 10.14+ but UI button does not appear in practice)
105106
* [iOS and macOS 10.14 or newer] Ability to check if notifications are enabled with specific type check
106107
* [Linux] Ability to to use themed/Flutter Assets icons and sound
107108
* [Linux] Ability to to set the category

‎flutter_local_notifications/example/ios/Runner/AppDelegate.swift‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,21 @@ import flutter_local_notifications
2121
GeneratedPluginRegistrant.register(with: self)
2222
return super.application(application, didFinishLaunchingWithOptions: launchOptions)
2323
}
24+
25+
/// Called when user taps "Configure in App" button in notification's context menu
26+
/// This delegate method is only called if the app has requested and been granted
27+
/// providesAppNotificationSettings permission.
28+
/// @see https://developer.apple.com/documentation/usernotifications/unnotificationsettings/providesappnotificationsettings
29+
@available(iOS 12.0, *)
30+
override func userNotificationCenter(
31+
_ center: UNUserNotificationCenter,
32+
openSettingsFor notification: UNNotification?
33+
) {
34+
let controller = window?.rootViewController as! FlutterViewController
35+
let channel = FlutterMethodChannel(
36+
name: "com.example.flutter_local_notifications_example/settings",
37+
binaryMessenger: controller.binaryMessenger)
38+
39+
channel.invokeMethod("showNotificationSettings", arguments: nil)
40+
}
2441
}

‎flutter_local_notifications/example/lib/configure_in_app_toggle.dart‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
import 'dart:io';
2+
3+
import 'package:device_info_plus/device_info_plus.dart';
4+
import 'package:flutter/material.dart';
5+
import 'package:flutter_local_notifications/flutter_local_notifications.dart';
6+
7+
/// A widget that displays a toggle for enabling the "Configure in App" option
8+
/// for iOS notifications (iOS 12+ only).
9+
class ConfigureInAppToggle extends StatefulWidget {
10+
/// Creates a ConfigureInAppToggle widget.
11+
const ConfigureInAppToggle({
12+
required this.flutterLocalNotificationsPlugin,
13+
Key? key,
14+
}) : super(key: key);
15+
16+
/// The FlutterLocalNotificationsPlugin instance.
17+
final FlutterLocalNotificationsPlugin flutterLocalNotificationsPlugin;
18+
19+
@override
20+
State<ConfigureInAppToggle> createState() => _ConfigureInAppToggleState();
21+
}
22+
23+
class _ConfigureInAppToggleState extends State<ConfigureInAppToggle> {
24+
bool _isIOS12OrHigher = false;
25+
26+
@override
27+
void initState() {
28+
super.initState();
29+
_checkIOSVersion();
30+
}
31+
32+
/// Checks if the device is running iOS 12 or higher.
33+
Future<void> _checkIOSVersion() async {
34+
if (Platform.isIOS) {
35+
final DeviceInfoPlugin deviceInfo = DeviceInfoPlugin();
36+
final IosDeviceInfo iosInfo = await deviceInfo.iosInfo;
37+
final List<String> version = iosInfo.systemVersion.split('.');
38+
if (version.isNotEmpty) {
39+
final int? majorVersion = int.tryParse(version[0]);
40+
setState(() {
41+
_isIOS12OrHigher = majorVersion != null && majorVersion >= 12;
42+
});
43+
}
44+
}
45+
}
46+
47+
@override
48+
Widget build(BuildContext context) => Container(
49+
decoration: BoxDecoration(
50+
color: Colors.grey.shade100,
51+
borderRadius: BorderRadius.circular(8),
52+
),
53+
child: Row(
54+
mainAxisAlignment: MainAxisAlignment.spaceBetween,
55+
children: <Widget>[
56+
const Expanded(
57+
child: Padding(
58+
padding: EdgeInsets.fromLTRB(16, 16, 4, 16),
59+
child: Column(
60+
crossAxisAlignment: CrossAxisAlignment.start,
61+
children: <Widget>[
62+
Text(
63+
"Show 'Configure in App' context menu option:",
64+
style: TextStyle(fontSize: 14),
65+
),
66+
SizedBox(height: 8),
67+
Text(
68+
'''
69+
• To access: view a notification on the lock screen, swipe left, and tap 'Options'
70+
• Requests 'providesAppNotificationSettings' permission (iOS 12+)
71+
• Tap is handled by 'userNotificationCenter(_:openSettingsFor:)' delegate method (not provided by plugin)
72+
• Note: Once enabled, this declaration cannot be revoked''',
73+
style: TextStyle(fontSize: 12, color: Colors.black87),
74+
),
75+
],
76+
),
77+
),
78+
),
79+
Padding(
80+
padding: const EdgeInsets.only(right: 16),
81+
child: FutureBuilder<NotificationsEnabledOptions?>(
82+
future: widget.flutterLocalNotificationsPlugin
83+
.resolvePlatformSpecificImplementation<
84+
IOSFlutterLocalNotificationsPlugin>()
85+
?.checkPermissions(),
86+
builder: (BuildContext context,
87+
AsyncSnapshot<NotificationsEnabledOptions?> snapshot) {
88+
final bool enabled =
89+
snapshot.data?.isProvidesAppNotificationSettingsEnabled ??
90+
false;
91+
return Switch(
92+
value: enabled,
93+
onChanged: !Platform.isIOS || !_isIOS12OrHigher || enabled
94+
? null
95+
: (bool value) async {
96+
final IOSFlutterLocalNotificationsPlugin? plugin =
97+
widget.flutterLocalNotificationsPlugin
98+
.resolvePlatformSpecificImplementation<
99+
IOSFlutterLocalNotificationsPlugin>();
100+
if (plugin != null) {
101+
await plugin.requestPermissions(
102+
alert: true,
103+
badge: true,
104+
sound: true,
105+
providesAppNotificationSettings: true,
106+
);
107+
setState(() {});
108+
}
109+
},
110+
);
111+
},
112+
),
113+
),
114+
],
115+
),
116+
);
117+
}

‎flutter_local_notifications/example/lib/main.dart‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ import 'package:path_provider/path_provider.dart';
1616
import 'package:timezone/data/latest_all.dart' as tz;
1717
import 'package:timezone/timezone.dart' as tz;
1818

19+
import 'configure_in_app_toggle.dart';
1920
import 'padded_button.dart';
2021
import 'plugin.dart';
2122
import 'repeating.dart' as repeating;
@@ -226,6 +227,29 @@ class _HomePageState extends State<HomePage> {
226227
_isAndroidPermissionGranted();
227228
_requestPermissions();
228229
_configureSelectNotificationSubject();
230+
231+
// Add method channel handler for notification settings
232+
const MethodChannel(
233+
'com.example.flutter_local_notifications_example/settings')
234+
.setMethodCallHandler((MethodCall call) async {
235+
if (call.method == 'showNotificationSettings') {
236+
// Show a simple dialog for demonstration
237+
await showDialog(
238+
context: context,
239+
builder: (BuildContext context) => AlertDialog(
240+
title: const Text('Notification Settings'),
241+
content: const Text(
242+
'This is a basic example of in-app notification settings UI'),
243+
actions: <Widget>[
244+
TextButton(
245+
onPressed: () => Navigator.pop(context),
246+
child: const Text('Close'),
247+
),
248+
],
249+
),
250+
);
251+
}
252+
});
229253
}
230254

231255
Future<void> _isAndroidPermissionGranted() async {
@@ -848,6 +872,15 @@ class _HomePageState extends State<HomePage> {
848872
await _showNotificationInNotificationCentreOnly();
849873
},
850874
),
875+
if (Platform.isIOS) ...<Widget>[
876+
ConfigureInAppToggle(
877+
flutterLocalNotificationsPlugin:
878+
flutterLocalNotificationsPlugin,
879+
),
880+
const SizedBox(
881+
height: 50,
882+
),
883+
],
851884
],
852885
if (!kIsWeb && Platform.isLinux) ...<Widget>[
853886
const Text(

‎flutter_local_notifications/ios/flutter_local_notifications/Sources/flutter_local_notifications/FlutterLocalNotificationsPlugin.m‎

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ @implementation FlutterLocalNotificationsPlugin {
4949
NSString *const REQUEST_PROVISIONAL_PERMISSION =
5050
@"requestProvisionalPermission";
5151
NSString *const REQUEST_CRITICAL_PERMISSION = @"requestCriticalPermission";
52+
NSString *const REQUEST_PROVIDES_APP_NOTIFICATION_SETTINGS = @"requestProvidesAppNotificationSettings";
5253
NSString *const DEFAULT_PRESENT_ALERT = @"defaultPresentAlert";
5354
NSString *const DEFAULT_PRESENT_SOUND = @"defaultPresentSound";
5455
NSString *const DEFAULT_PRESENT_BADGE = @"defaultPresentBadge";
@@ -59,6 +60,7 @@ @implementation FlutterLocalNotificationsPlugin {
5960
NSString *const BADGE_PERMISSION = @"badge";
6061
NSString *const PROVISIONAL_PERMISSION = @"provisional";
6162
NSString *const CRITICAL_PERMISSION = @"critical";
63+
NSString *const PROVIDES_APP_NOTIFICATION_SETTINGS = @"providesAppNotificationSettings";
6264
NSString *const CALLBACK_DISPATCHER = @"callbackDispatcher";
6365
NSString *const ON_NOTIFICATION_CALLBACK_DISPATCHER =
6466
@"onNotificationCallbackDispatcher";
@@ -106,6 +108,7 @@ @implementation FlutterLocalNotificationsPlugin {
106108
NSString *const IS_BADGE_ENABLED = @"isBadgeEnabled";
107109
NSString *const IS_PROVISIONAL_ENABLED = @"isProvisionalEnabled";
108110
NSString *const IS_CRITICAL_ENABLED = @"isCriticalEnabled";
111+
NSString *const IS_PROVIDES_APP_NOTIFICATION_SETTINGS_ENABLED = @"isProvidesAppNotificationSettingsEnabled";
109112

110113
NSString *const CRITICAL_SOUND_VOLUME = @"criticalSoundVolume";
111114

@@ -347,6 +350,7 @@ - (void)initialize:(NSDictionary *_Nonnull)arguments
347350
bool requestedBadgePermission = false;
348351
bool requestedProvisionalPermission = false;
349352
bool requestedCriticalPermission = false;
353+
bool requestedProvidesAppNotificationSettings = false;
350354
NSMutableDictionary *presentationOptions = [[NSMutableDictionary alloc] init];
351355
if ([self containsKey:DEFAULT_PRESENT_ALERT forDictionary:arguments]) {
352356
presentationOptions[PRESENT_ALERT] =
@@ -394,6 +398,10 @@ - (void)initialize:(NSDictionary *_Nonnull)arguments
394398
requestedCriticalPermission =
395399
[arguments[REQUEST_CRITICAL_PERMISSION] boolValue];
396400
}
401+
if ([self containsKey:REQUEST_PROVIDES_APP_NOTIFICATION_SETTINGS forDictionary:arguments]) {
402+
requestedProvidesAppNotificationSettings =
403+
[arguments[REQUEST_PROVIDES_APP_NOTIFICATION_SETTINGS] boolValue];
404+
}
397405

398406
if ([self containsKey:@"dispatcher_handle" forDictionary:arguments] &&
399407
[self containsKey:@"callback_handle" forDictionary:arguments]) {
@@ -412,19 +420,20 @@ - (void)initialize:(NSDictionary *_Nonnull)arguments
412420
badgePermission:requestedBadgePermission
413421
provisionalPermission:requestedProvisionalPermission
414422
criticalPermission:requestedCriticalPermission
415-
result:result];
423+
providesAppNotificationSettings:requestedProvidesAppNotificationSettings
424+
result:result];
416425
}];
417426

418427
_initialized = true;
419428
}
420429
- (void)requestPermissions:(NSDictionary *_Nonnull)arguments
421-
422430
result:(FlutterResult _Nonnull)result {
423431
bool soundPermission = false;
424432
bool alertPermission = false;
425433
bool badgePermission = false;
426434
bool provisionalPermission = false;
427435
bool criticalPermission = false;
436+
bool providesAppNotificationSettings = false;
428437
if ([self containsKey:SOUND_PERMISSION forDictionary:arguments]) {
429438
soundPermission = [arguments[SOUND_PERMISSION] boolValue];
430439
}
@@ -440,11 +449,15 @@ - (void)requestPermissions:(NSDictionary *_Nonnull)arguments
440449
if ([self containsKey:CRITICAL_PERMISSION forDictionary:arguments]) {
441450
criticalPermission = [arguments[CRITICAL_PERMISSION] boolValue];
442451
}
452+
if ([self containsKey:PROVIDES_APP_NOTIFICATION_SETTINGS forDictionary:arguments]) {
453+
providesAppNotificationSettings = [arguments[PROVIDES_APP_NOTIFICATION_SETTINGS] boolValue];
454+
}
443455
[self requestPermissionsImpl:soundPermission
444456
alertPermission:alertPermission
445457
badgePermission:badgePermission
446458
provisionalPermission:provisionalPermission
447459
criticalPermission:criticalPermission
460+
providesAppNotificationSettings:providesAppNotificationSettings
448461
result:result];
449462
}
450463

@@ -453,9 +466,10 @@ - (void)requestPermissionsImpl:(bool)soundPermission
453466
badgePermission:(bool)badgePermission
454467
provisionalPermission:(bool)provisionalPermission
455468
criticalPermission:(bool)criticalPermission
469+
providesAppNotificationSettings:(bool)providesAppNotificationSettings
456470
result:(FlutterResult _Nonnull)result {
457471
if (!soundPermission && !alertPermission && !badgePermission &&
458-
!criticalPermission) {
472+
!criticalPermission && !providesAppNotificationSettings) {
459473
result(@NO);
460474
return;
461475
}
@@ -479,6 +493,9 @@ - (void)requestPermissionsImpl:(bool)soundPermission
479493
if (criticalPermission) {
480494
authorizationOptions += UNAuthorizationOptionCriticalAlert;
481495
}
496+
if (providesAppNotificationSettings) {
497+
authorizationOptions += UNAuthorizationOptionProvidesAppNotificationSettings;
498+
}
482499
}
483500
[center requestAuthorizationWithOptions:(authorizationOptions)
484501
completionHandler:^(BOOL granted,
@@ -502,12 +519,14 @@ - (void)checkPermissions:(NSDictionary *_Nonnull)arguments
502519
BOOL isBadgeEnabled = settings.badgeSetting == UNNotificationSettingEnabled;
503520
BOOL isProvisionalEnabled = false;
504521
BOOL isCriticalEnabled = false;
522+
BOOL isProvidesAppNotificationSettingsEnabled = false;
505523

506524
if (@available(iOS 12.0, *)) {
507525
isProvisionalEnabled =
508526
settings.authorizationStatus == UNAuthorizationStatusProvisional;
509527
isCriticalEnabled =
510528
settings.criticalAlertSetting == UNNotificationSettingEnabled;
529+
isProvidesAppNotificationSettingsEnabled = settings.providesAppNotificationSettings;
511530
}
512531

513532
NSDictionary *dict = @{
@@ -517,6 +536,7 @@ - (void)checkPermissions:(NSDictionary *_Nonnull)arguments
517536
IS_BADGE_ENABLED : @(isBadgeEnabled),
518537
IS_PROVISIONAL_ENABLED : @(isProvisionalEnabled),
519538
IS_CRITICAL_ENABLED : @(isCriticalEnabled),
539+
IS_PROVIDES_APP_NOTIFICATION_SETTINGS_ENABLED : @(isProvidesAppNotificationSettingsEnabled),
520540
};
521541

522542
result(dict);

‎flutter_local_notifications/lib/src/platform_flutter_local_notifications.dart‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -700,13 +700,15 @@ class IOSFlutterLocalNotificationsPlugin
700700
bool badge = false,
701701
bool provisional = false,
702702
bool critical = false,
703+
bool providesAppNotificationSettings = false,
703704
}) =>
704705
_channel.invokeMethod<bool?>('requestPermissions', <String, bool>{
705706
'sound': sound,
706707
'alert': alert,
707708
'badge': badge,
708709
'provisional': provisional,
709710
'critical': critical,
711+
'providesAppNotificationSettings': providesAppNotificationSettings,
710712
});
711713

712714
/// Returns whether the app can post notifications and what kind of.
@@ -726,6 +728,8 @@ class IOSFlutterLocalNotificationsPlugin
726728
isSoundEnabled: dict['isSoundEnabled'] ?? false,
727729
isProvisionalEnabled: dict['isProvisionalEnabled'] ?? false,
728730
isCriticalEnabled: dict['isCriticalEnabled'] ?? false,
731+
isProvidesAppNotificationSettingsEnabled:
732+
dict['isProvidesAppNotificationSettingsEnabled'] ?? false,
729733
);
730734
},
731735
);
@@ -895,13 +899,15 @@ class MacOSFlutterLocalNotificationsPlugin
895899
bool badge = false,
896900
bool provisional = false,
897901
bool critical = false,
902+
bool providesAppNotificationSettings = false,
898903
}) =>
899904
_channel.invokeMethod<bool>('requestPermissions', <String, bool?>{
900905
'sound': sound,
901906
'alert': alert,
902907
'badge': badge,
903908
'provisional': provisional,
904909
'critical': critical,
910+
'providesAppNotificationSettings': providesAppNotificationSettings,
905911
});
906912

907913
/// Returns whether the app can post notifications and what kind of.
@@ -921,6 +927,8 @@ class MacOSFlutterLocalNotificationsPlugin
921927
isSoundEnabled: dict['isSoundEnabled'] ?? false,
922928
isProvisionalEnabled: dict['isProvisionalEnabled'] ?? false,
923929
isCriticalEnabled: dict['isCriticalEnabled'] ?? false,
930+
isProvidesAppNotificationSettingsEnabled:
931+
dict['isProvidesAppNotificationSettingsEnabled'] ?? false,
924932
);
925933
});
926934

0 commit comments

Comments
 (0)