[flutter_local_notifications / flutter_local_notifications_platform_interface] Exposes removeAllPendingNotificationRequests via implementing cancelAllPendingNotifications() (#2639)

TaeBbong · web-flow · commit b9d6d9a00c48 · 2025-06-22T16:02:12.000+10:00
* feat(dart): add cancelAllPendingNotifications API to public plugin interface

* feat(android): implement cancelAllPendingNotifications via AlarmManager

* feat(dart): add cancelAllPendingNotifications API to plugin interface

* test(example): add UI to test cancelAllPendingNotifications manually

* feat(ios): implement cancelAllPendingNotifications using removeAllPendingNotificationRequests()

* feat(macos): implement cancelAllPendingNotifications using removeAllPendingNotificationRequests()

* test: add test codes for android, ios, macos

* fix: dart analyzer line length exceed issue

* fix: add missed symbol

* fix: typo

* test: github actions workflow(ios integration)

* fix: keep consistency of symbol names

* docs: update api docs

* fix: add if-statement to check supported platforms

* fix: remove unnecessary null-check statement
diff --git a/flutter_local_notifications/android/src/main/java/com/dexterous/flutterlocalnotifications/FlutterLocalNotificationsPlugin.java b/flutter_local_notifications/android/src/main/java/com/dexterous/flutterlocalnotifications/FlutterLocalNotificationsPlugin.java
@@ -157,9 +157,10 @@ public class FlutterLocalNotificationsPlugin
   private static final String SHOW_METHOD = "show";
   private static final String CANCEL_METHOD = "cancel";
   private static final String CANCEL_ALL_METHOD = "cancelAll";
+  private static final String CANCEL_ALL_PENDING_NOTIFICATIONS_METHOD = "cancelAllPendingNotifications";
   private static final String ZONED_SCHEDULE_METHOD = "zonedSchedule";
   private static final String PERIODICALLY_SHOW_METHOD = "periodicallyShow";
-  private static final String PERIODICALLY_SHOW_WITH_DURATION = "periodicallyShowWithDuration";
+  private static final String PERIODICALLY_SHOW_WITH_DURATION_METHOD = "periodicallyShowWithDuration";
   private static final String GET_NOTIFICATION_APP_LAUNCH_DETAILS_METHOD =
       "getNotificationAppLaunchDetails";
   private static final String REQUEST_NOTIFICATIONS_PERMISSION_METHOD =
@@ -1515,7 +1516,7 @@ public void fail(String message) {
       case PERIODICALLY_SHOW_METHOD:
         repeat(call, result);
         break;
-      case PERIODICALLY_SHOW_WITH_DURATION:
+      case PERIODICALLY_SHOW_WITH_DURATION_METHOD:
         repeat(call, result);
         break;
       case CANCEL_METHOD:
@@ -1524,6 +1525,9 @@ public void fail(String message) {
       case CANCEL_ALL_METHOD:
         cancelAllNotifications(result);
         break;
+      case CANCEL_ALL_PENDING_NOTIFICATIONS_METHOD:
+        cancelAllPendingNotifications(result);
+        break;
       case PENDING_NOTIFICATION_REQUESTS_METHOD:
         pendingNotificationRequests(result);
         break;
@@ -1839,6 +1843,29 @@ private void cancelAllNotifications(Result result) {
     result.success(null);
   }
 
+  private void cancelAllPendingNotifications(Result result) {
+    ArrayList<NotificationDetails> scheduledNotifications =
+        loadScheduledNotifications(applicationContext);
+
+    if (scheduledNotifications == null || scheduledNotifications.isEmpty()) {
+        result.success(null);
+        return;
+    }
+
+    AlarmManager alarmManager = getAlarmManager(applicationContext);
+    Intent intent = new Intent(applicationContext, ScheduledNotificationReceiver.class);
+
+    for (NotificationDetails scheduledNotification : scheduledNotifications) {
+      PendingIntent pendingIntent =
+          getBroadcastPendingIntent(applicationContext, scheduledNotification.id, intent);
+      alarmManager.cancel(pendingIntent);
+    }
+
+    saveScheduledNotifications(applicationContext, new ArrayList<>());
+    result.success(null);
+  }
+
+
   public void requestNotificationsPermission(@NonNull PermissionRequestListener callback) {
     if (permissionRequestProgress != PermissionRequestProgress.None) {
       callback.fail(PERMISSION_REQUEST_IN_PROGRESS_ERROR_MESSAGE);
diff --git a/flutter_local_notifications/example/lib/main.dart b/flutter_local_notifications/example/lib/main.dart
@@ -442,6 +442,13 @@ class _HomePageState extends State<HomePage> {
                       await _cancelAllNotifications();
                     },
                   ),
+                  if (Platform.isAndroid || Platform.isIOS || Platform.isMacOS)
+                    PaddedElevatedButton(
+                      buttonText: 'Cancel all pending notifications',
+                      onPressed: () async {
+                        await _cancelAllPendingNotifications();
+                      },
+                    ),
                   if (!Platform.isWindows) ...repeating.examples(context),
                   const Divider(),
                   const Text(
@@ -1891,6 +1898,10 @@ class _HomePageState extends State<HomePage> {
     await flutterLocalNotificationsPlugin.cancelAll();
   }
 
+  Future<void> _cancelAllPendingNotifications() async {
+    await flutterLocalNotificationsPlugin.cancelAllPendingNotifications();
+  }
+
   Future<void> _showOngoingNotification() async {
     const AndroidNotificationDetails androidNotificationDetails =
         AndroidNotificationDetails('your channel id', 'your channel name',
diff --git a/flutter_local_notifications/ios/flutter_local_notifications/Sources/flutter_local_notifications/FlutterLocalNotificationsPlugin.m b/flutter_local_notifications/ios/flutter_local_notifications/Sources/flutter_local_notifications/FlutterLocalNotificationsPlugin.m
@@ -26,7 +26,8 @@ @implementation FlutterLocalNotificationsPlugin {
     @"periodicallyShowWithDuration";
 NSString *const CANCEL_METHOD = @"cancel";
 NSString *const CANCEL_ALL_METHOD = @"cancelAll";
-NSString *const PENDING_NOTIFICATIONS_REQUESTS_METHOD =
+NSString *const CANCEL_ALL_PENDING_NOTIFICATIONS_METHOD = @"cancelAllPendingNotifications";
+NSString *const PENDING_NOTIFICATION_REQUESTS_METHOD =
     @"pendingNotificationRequests";
 NSString *const GET_ACTIVE_NOTIFICATIONS_METHOD = @"getActiveNotifications";
 NSString *const GET_NOTIFICATION_APP_LAUNCH_DETAILS_METHOD =
@@ -185,6 +186,8 @@ - (void)handleMethodCall:(FlutterMethodCall *)call
     [self cancel:((NSNumber *)call.arguments) result:result];
   } else if ([CANCEL_ALL_METHOD isEqualToString:call.method]) {
     [self cancelAll:result];
+  } else if ([CANCEL_ALL_PENDING_NOTIFICATIONS_METHOD isEqualToString:call.method]) {
+    [self cancelAllPendingNotifications:result];
   } else if ([GET_NOTIFICATION_APP_LAUNCH_DETAILS_METHOD
                  isEqualToString:call.method]) {
 
@@ -195,7 +198,7 @@ - (void)handleMethodCall:(FlutterMethodCall *)call
     notificationAppLaunchDetails[@"notificationResponse"] =
         _launchNotificationResponseDict;
     result(notificationAppLaunchDetails);
-  } else if ([PENDING_NOTIFICATIONS_REQUESTS_METHOD
+  } else if ([PENDING_NOTIFICATION_REQUESTS_METHOD
                  isEqualToString:call.method]) {
     [self pendingNotificationRequests:result];
   } else if ([GET_ACTIVE_NOTIFICATIONS_METHOD isEqualToString:call.method]) {
@@ -576,6 +579,13 @@ - (void)cancelAll:(FlutterResult _Nonnull)result API_AVAILABLE(ios(10.0)) {
   result(nil);
 }
 
+- (void)cancelAllPendingNotifications:(FlutterResult _Nonnull)result API_AVAILABLE(ios(10.0)) {
+  UNUserNotificationCenter *center = 
+      [UNUserNotificationCenter currentNotificationCenter];
+  [center removeAllPendingNotificationRequests];
+  result(nil);
+}
+
 - (UNMutableNotificationContent *)
     buildStandardNotificationContent:(NSDictionary *)arguments
                               result:(FlutterResult _Nonnull)result
diff --git a/flutter_local_notifications/lib/src/flutter_local_notifications_plugin.dart b/flutter_local_notifications/lib/src/flutter_local_notifications_plugin.dart
@@ -302,6 +302,17 @@ class FlutterLocalNotificationsPlugin {
     await FlutterLocalNotificationsPlatform.instance.cancelAll();
   }
 
+  /// Cancels/removes all pending notifications.
+  ///
+  /// This only applies to notifications that have been scheduled.
+  ///
+  /// The method is supported on Android, iOS and macOS.
+  /// On other platforms, an [UnimplementedError] will be thrown.
+  Future<void> cancelAllPendingNotifications() async {
+    await FlutterLocalNotificationsPlatform.instance
+        .cancelAllPendingNotifications();
+  }
+
   /// Schedules a notification to be shown at the specified date and time
   /// relative to a specific time zone.
   ///
diff --git a/flutter_local_notifications/lib/src/platform_flutter_local_notifications.dart b/flutter_local_notifications/lib/src/platform_flutter_local_notifications.dart
@@ -42,6 +42,11 @@ class MethodChannelFlutterLocalNotificationsPlugin
   @override
   Future<void> cancelAll() => _channel.invokeMethod('cancelAll');
 
+  @override
+  Future<void> cancelAllPendingNotifications() async {
+    await _channel.invokeMethod('cancelAllPendingNotifications');
+  }
+
   @override
   Future<NotificationAppLaunchDetails?>
       getNotificationAppLaunchDetails() async {
diff --git a/flutter_local_notifications/macos/flutter_local_notifications/Sources/flutter_local_notifications/FlutterLocalNotificationsPlugin.swift b/flutter_local_notifications/macos/flutter_local_notifications/Sources/flutter_local_notifications/FlutterLocalNotificationsPlugin.swift
@@ -180,6 +180,8 @@ public class FlutterLocalNotificationsPlugin: NSObject, FlutterPlugin, UNUserNot
             cancel(call, result)
         case "cancelAll":
             cancelAll(result)
+        case "cancelAllPendingNotifications":
+            cancelAllPendingNotifications(result)
         case "pendingNotificationRequests":
             pendingNotificationRequests(result)
         case "getActiveNotifications":
@@ -315,6 +317,12 @@ public class FlutterLocalNotificationsPlugin: NSObject, FlutterPlugin, UNUserNot
         result(nil)
     }
 
+    func cancelAllPendingNotifications(_ result: @escaping FlutterResult) {
+        let center = UNUserNotificationCenter.current()
+        center.removeAllPendingNotificationRequests()
+        result(nil)
+    }
+
     func pendingNotificationRequests(_ result: @escaping FlutterResult) {
         UNUserNotificationCenter.current().getPendingNotificationRequests { (requests) in
             var requestDictionaries: [[String: Any?]] = []
diff --git a/flutter_local_notifications/test/android_flutter_local_notifications_test.dart b/flutter_local_notifications/test/android_flutter_local_notifications_test.dart
@@ -2618,6 +2618,13 @@ void main() {
       expect(log, <Matcher>[isMethodCall('cancelAll', arguments: null)]);
     });
 
+    test('cancelAllPendingNotifications', () async {
+      await flutterLocalNotificationsPlugin.cancelAllPendingNotifications();
+      expect(log, <Matcher>[
+        isMethodCall('cancelAllPendingNotifications', arguments: null)
+      ]);
+    });
+
     test('pendingNotificationRequests', () async {
       await flutterLocalNotificationsPlugin.pendingNotificationRequests();
       expect(log, <Matcher>[
diff --git a/flutter_local_notifications/test/ios_flutter_local_notifications_test.dart b/flutter_local_notifications/test/ios_flutter_local_notifications_test.dart
@@ -748,6 +748,13 @@ void main() {
       expect(log, <Matcher>[isMethodCall('cancelAll', arguments: null)]);
     });
 
+    test('cancelAllPendingNotifications', () async {
+      await flutterLocalNotificationsPlugin.cancelAllPendingNotifications();
+      expect(log, <Matcher>[
+        isMethodCall('cancelAllPendingNotifications', arguments: null)
+      ]);
+    });
+
     test('pendingNotificationRequests', () async {
       await flutterLocalNotificationsPlugin.pendingNotificationRequests();
       expect(log, <Matcher>[
diff --git a/flutter_local_notifications/test/macos_flutter_local_notifications_test.dart b/flutter_local_notifications/test/macos_flutter_local_notifications_test.dart
@@ -669,6 +669,13 @@ void main() {
       expect(log, <Matcher>[isMethodCall('cancelAll', arguments: null)]);
     });
 
+    test('cancelAllPendingNotifications', () async {
+      await flutterLocalNotificationsPlugin.cancelAllPendingNotifications();
+      expect(log, <Matcher>[
+        isMethodCall('cancelAllPendingNotifications', arguments: null)
+      ]);
+    });
+
     test('pendingNotificationRequests', () async {
       await flutterLocalNotificationsPlugin.pendingNotificationRequests();
       expect(log, <Matcher>[
diff --git a/flutter_local_notifications_platform_interface/lib/flutter_local_notifications_platform_interface.dart b/flutter_local_notifications_platform_interface/lib/flutter_local_notifications_platform_interface.dart
@@ -78,6 +78,14 @@ abstract class FlutterLocalNotificationsPlatform extends PlatformInterface {
     throw UnimplementedError('cancelAll() has not been implemented');
   }
 
+  /// Cancels/removes all pending notifications.
+  ///
+  /// This only applies to notifications that have been scheduled.
+  Future<void> cancelAllPendingNotifications() async {
+    throw UnimplementedError(
+        'cancelAllPendingNotifications() has not been implemented');
+  }
+
   /// Returns a list of notifications pending to be delivered/shown
   Future<List<PendingNotificationRequest>> pendingNotificationRequests() {
     throw UnimplementedError(
