🍎 ✨ 📝 Issue #2191: Implement the ability to clear one notification on iOS and update documentation (#2478)

Author: merrygobyebye

docs/API.md

@@ -17,7 +17,7 @@
 - [push.getApplicationIconBadgeNumber() - iOS & Android only](#pushgetapplicationiconbadgenumbersuccesshandler-errorhandler---ios--android-only)
 - [push.finish() - iOS only](#pushfinishsuccesshandler-errorhandler-id---ios-only)
 - [push.clearAllNotifications() - iOS & Android only](#pushclearallnotificationssuccesshandler-errorhandler---ios--android-only)
-- [push.clearNotification() - Android only](#pushclearnotificationid-successhandler-errorhandler---android-only)
+- [push.clearNotification() - iOS & Android only](#pushclearnotificationid-successhandler-errorhandler---ios--android-only)
 
 ## PushNotification.init(options)
 
@@ -592,7 +592,7 @@ push.clearAllNotifications(
 );
 ```
 
-## push.clearNotification(id, successHandler, errorHandler) - Android only
+## push.clearNotification(id, successHandler, errorHandler) - iOS & Android only
 
 Tells the OS to clear the notification that corresponds to the id argument, from the Notification Center
 

docs/PAYLOAD.md

@@ -161,6 +161,7 @@ The JSON message can contain the following fields, see [Apple developer docs](ht
     "thread-id": "id", // Provide this key with a string value that represents the app-specific identifier for grouping notifications
     "sound": "default"  // play default sound, or custom sound, see [iOS Sound](#sound-1) section
   },
+  "notId": 1,
   "custom_key1": "value1",
   "custom_key2": "value2"
 }
@@ -173,7 +174,7 @@ This is the JSON-encoded format you can send via AWS-SNS's web UI:
 ```json
 {
   "APNS_SANDBOX":
-    "{\"aps\":{\"alert\":{\"title\":\"A short string describing the purpose of the notification\",\"body\":\"The text of the alert message\",\"launch-image\":\"The filename of an image file in the app bundle, with or without the filename extension. The image is used as the launch image when users tap the action button or move the action slider\"},\"badge\":5,\"content-available\":\"0\",\"category\":\"identifier\",\"thread-id\":\"id\",\"sound\":\"default\"},\"custom_key1\":\"value1\",\"custom_key2\":\"value2\"}"
+    "{\"aps\":{\"alert\":{\"title\":\"A short string describing the purpose of the notification\",\"body\":\"The text of the alert message\",\"launch-image\":\"The filename of an image file in the app bundle, with or without the filename extension. The image is used as the launch image when users tap the action button or move the action slider\"},\"badge\":5,\"content-available\":\"0\",\"category\":\"identifier\",\"thread-id\":\"id\",\"sound\":\"default\"},\"notId\":1,\"custom_key1\":\"value1\",\"custom_key2\":\"value2\"}"
 }
 ```
 
@@ -203,6 +204,7 @@ Note that the properties are "normalized" accross platforms, so this is passed t
     "coldstart": false,
     "foreground": false,
     "content-available": "0",
+    "notId": 1,
     "custom_key1": "value1",
     "custom_key2": "value2",
     "launch-image": "The filename of an image file in the app bundle, with or without the filename extension. The image is used as the launch image when users tap the action button or move the action slider",

src/ios/PushPlugin.h

@@ -59,6 +59,7 @@
 - (void)unregister:(CDVInvokedUrlCommand*)command;
 - (void)subscribe:(CDVInvokedUrlCommand*)command;
 - (void)unsubscribe:(CDVInvokedUrlCommand*)command;
+- (void)clearNotification:(CDVInvokedUrlCommand*)command;
 
 - (void)didRegisterForRemoteNotificationsWithDeviceToken:(NSData *)deviceToken;
 - (void)didFailToRegisterForRemoteNotificationsWithError:(NSError *)error;

src/ios/PushPlugin.m

@@ -466,6 +466,28 @@ - (void)notificationReceived {
     }
 }
 
+- (void)clearNotification:(CDVInvokedUrlCommand *)command
+{
+    NSNumber *notId = [command.arguments objectAtIndex:0];
+    [[UNUserNotificationCenter currentNotificationCenter] getDeliveredNotificationsWithCompletionHandler:^(NSArray<UNNotification *> * _Nonnull notifications) {
+        /*
+         * If the server generates a unique "notId" for every push notification, there should only be one match in these arrays, but if not, it will delete
+         * all notifications with the same value for "notId"
+         */
+        NSPredicate *matchingNotificationPredicate = [NSPredicate predicateWithFormat:@"request.content.userInfo.notId == %@", notId];
+        NSArray<UNNotification *> *matchingNotifications = [notifications filteredArrayUsingPredicate:matchingNotificationPredicate];
+        NSMutableArray<NSString *> *matchingNotificationIdentifiers = [NSMutableArray array];
+        for (UNNotification *notification in matchingNotifications) {
+            [matchingNotificationIdentifiers addObject:notification.request.identifier];
+        }
+        [[UNUserNotificationCenter currentNotificationCenter] removeDeliveredNotificationsWithIdentifiers:matchingNotificationIdentifiers];
+        
+        NSString *message = [NSString stringWithFormat:@"Cleared notification with ID: %@", notId];
+        CDVPluginResult *commandResult = [CDVPluginResult resultWithStatus:CDVCommandStatus_OK messageAsString:message];
+        [self.commandDelegate sendPluginResult:commandResult callbackId:command.callbackId];
+    }];
+}
+
 - (void)setApplicationIconBadgeNumber:(CDVInvokedUrlCommand *)command
 {
     NSMutableDictionary* options = [command.arguments objectAtIndex:0];