feat: add removeAllPendingNotificationRequests method (#206)

Author: Naturalclar

README.md

@@ -244,13 +244,13 @@ details is an object containing:
 
 ---
 
-### `cancelAllLocalNotifications()`
+### `remooveAllPendingNotificationRequests()`
 
 ```jsx
-PushNotificationIOS.cancelAllLocalNotifications();
+PushNotificationIOS.remooveAllPendingNotificationRequests();
 ```
 
-Cancels all scheduled localNotifications
+Removes all pending notification requests in the notification center.
 
 ---
 

example/App.js

@@ -55,16 +55,11 @@ export const App = () => {
 
     return () => {
       PushNotificationIOS.removeEventListener('register');
-      PushNotificationIOS.removeEventListener(
-        'registrationError'
-      );
-      PushNotificationIOS.removeEventListener(
-        'notification'
-      );
-      PushNotificationIOS.removeEventListener(
-        'localNotification'
-      );
+      PushNotificationIOS.removeEventListener('registrationError');
+      PushNotificationIOS.removeEventListener('notification');
+      PushNotificationIOS.removeEventListener('localNotification');
     };
+    // eslint-disable-next-line react-hooks/exhaustive-deps
   }, []);
 
   const sendNotification = () => {
@@ -87,7 +82,7 @@ export const App = () => {
       aps: {
         category: 'REACT_NATIVE',
         'content-available': 1,
-      }
+      },
     });
   };
 
@@ -102,10 +97,14 @@ export const App = () => {
   const scheduleLocalNotification = () => {
     PushNotificationIOS.scheduleLocalNotification({
       alertBody: 'Test Local Notification',
-      fireDate: new Date().toISOString(),
+      fireDate: new Date(new Date().valueOf() + 2000).toISOString(),
     });
   };
 
+  const removeAllPendingNotificationRequests = () => {
+    PushNotificationIOS.removeAllPendingNotificationRequests();
+  };
+
   const onRegistered = (deviceToken) => {
     Alert.alert('Registered For Remote Push', `Device Token: ${deviceToken}`, [
       {
@@ -129,7 +128,7 @@ export const App = () => {
   };
 
   const onRemoteNotification = (notification) => {
-    const isClicked = notification.getData().userInteraction === 1
+    const isClicked = notification.getData().userInteraction === 1;
 
     const result = `
       Title:  ${notification.getTitle()};\n
@@ -148,7 +147,7 @@ export const App = () => {
         },
       ]);
     } else {
-       Alert.alert('Push Notification Received', result, [
+      Alert.alert('Push Notification Received', result, [
         {
           text: 'Dismiss',
           onPress: null,
@@ -158,7 +157,7 @@ export const App = () => {
   };
 
   const onLocalNotification = (notification) => {
-    const isClicked = notification.getData().userInteraction === 1
+    const isClicked = notification.getData().userInteraction === 1;
 
     Alert.alert(
       'Local Notification Received',
@@ -192,8 +191,14 @@ export const App = () => {
         onPress={scheduleLocalNotification}
         label="Schedule fake local notification"
       />
-
-      <Button onPress={sendSilentNotification} label="Send fake silent notification" />
+      <Button
+        onPress={removeAllPendingNotificationRequests}
+        label="Remove All Pending Notification Requests"
+      />
+      <Button
+        onPress={sendSilentNotification}
+        label="Send fake silent notification"
+      />
 
       <Button
         onPress={() => PushNotificationIOS.setApplicationIconBadgeNumber(42)}

index.d.ts

@@ -210,9 +210,16 @@ export interface PushNotificationIOSStatic {
 
   /**
    * Cancels all scheduled localNotifications
+   * @deprecated use `removeAllPendingNotificationRequests` instead
+   * - This method is deprecated in iOS 10 and will be removed from future release
    */
   cancelAllLocalNotifications(): void;
 
+  /**
+   * Removes all pending notifications
+   */
+  removeAllPendingNotificationRequests(): void;
+
   /**
    * Remove all delivered notifications from Notification Center.
    *

ios/RNCPushNotificationIOS.m

@@ -391,11 +391,23 @@ - (void)handleRemoteNotificationRegistrationError:(NSNotification *)notification
   [RCTSharedApplication() scheduleLocalNotification:notification];
 }
 
+/**
+ * Method not Available in iOS11+
+ * TODO: This method will be removed in the next major version
+ */
 RCT_EXPORT_METHOD(cancelAllLocalNotifications)
 {
   [RCTSharedApplication() cancelAllLocalNotifications];
 }
 
+RCT_EXPORT_METHOD(removeAllPendingNotificationRequests)
+{
+    if ([UNUserNotificationCenter class]) {
+      UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter];
+      [center removeAllPendingNotificationRequests];
+    }
+}
+
 RCT_EXPORT_METHOD(cancelLocalNotifications:(NSDictionary<NSString *, id> *)userInfo)
 {
   for (UILocalNotification *notification in RCTSharedApplication().scheduledLocalNotifications) {

js/index.js

@@ -120,8 +120,8 @@ class PushNotificationIOS {
 
   /**
    * Cancels all scheduled localNotifications.
-   *
-   * See https://reactnative.dev/docs/pushnotificationios.html#cancelalllocalnotifications
+   * @deprecated use `removeAllPendingNotificationRequests` instead
+   * - This method is deprecated in iOS 10 and will be removed from future release
    */
   static cancelAllLocalNotifications() {
     invariant(
@@ -131,6 +131,17 @@ class PushNotificationIOS {
     RNCPushNotificationIOS.cancelAllLocalNotifications();
   }
 
+  /**
+   * Removes all pending notifications
+   */
+  static removeAllPendingNotificationRequests() {
+    invariant(
+      RNCPushNotificationIOS,
+      'PushNotificationManager is not available.',
+    );
+    RNCPushNotificationIOS.removeAllPendingNotificationRequests();
+  }
+
   /**
    * Remove all delivered notifications from Notification Center.
    *