feat(push-notifications): add unregister functions (#1498)

* feat(push-notifications): add unregister functions * Add to `definitions.ts` and `README.md` * Update "since" to 5.0.0 * move `call.resolve`
ionic-team · Mar 24, 2023 · 878e295 · 878e295
1 parent 999a2a6
commit 878e295
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 0 deletions.
diff --git a/push-notifications/README.md b/push-notifications/README.md
@@ -159,6 +159,7 @@ const getDeliveredNotifications = async () => {
 <docgen-index>
 
 * [`register()`](#register)
+* [`unregister()`](#unregister)
 * [`getDeliveredNotifications()`](#getdeliverednotifications)
 * [`removeDeliveredNotifications(...)`](#removedeliverednotifications)
 * [`removeAllDeliveredNotifications()`](#removealldeliverednotifications)
@@ -197,6 +198,21 @@ notification permissions, use `requestPermissions()` first.
 --------------------
 
 
+### unregister()
+
+```typescript
+unregister() => Promise<void>
+```
+
+Unregister the app from push notifications.
+
+This will delete a firebase token on Android, and unregister APNS on iOS.
+
+**Since:** 5.0.0
+
+--------------------
+
+
 ### getDeliveredNotifications()
 
 ```typescript

diff --git a/...roid/src/main/java/com/capacitorjs/plugins/pushnotifications/PushNotificationsPlugin.java b/...roid/src/main/java/com/capacitorjs/plugins/pushnotifications/PushNotificationsPlugin.java
@@ -117,6 +117,13 @@ public void register(PluginCall call) {
         call.resolve();
     }
 
+    @PluginMethod
+    public void unregister(PluginCall call) {
+        FirebaseMessaging.getInstance().setAutoInitEnabled(false);
+        FirebaseMessaging.getInstance().deleteToken();
+        call.resolve();
+    }
+
     @PluginMethod
     public void getDeliveredNotifications(PluginCall call) {
         JSArray notifications = new JSArray();

diff --git a/push-notifications/ios/Plugin/PushNotificationsPlugin.m b/push-notifications/ios/Plugin/PushNotificationsPlugin.m
@@ -5,6 +5,7 @@
 // each method the plugin supports using the CAP_PLUGIN_METHOD macro.
 CAP_PLUGIN(PushNotificationsPlugin, "PushNotifications",
            CAP_PLUGIN_METHOD(register, CAPPluginReturnPromise);
+           CAP_PLUGIN_METHOD(unregister, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(checkPermissions, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(requestPermissions, CAPPluginReturnPromise);
            CAP_PLUGIN_METHOD(getDeliveredNotifications, CAPPluginReturnPromise);

diff --git a/push-notifications/ios/Plugin/PushNotificationsPlugin.swift b/push-notifications/ios/Plugin/PushNotificationsPlugin.swift
@@ -47,6 +47,16 @@ public class PushNotificationsPlugin: CAPPlugin {
         call.resolve()
     }
 
+    /**
+     * Unregister for remote notifications
+     */
+    @objc func unregister(_ call: CAPPluginCall) {
+        DispatchQueue.main.async {
+            UIApplication.shared.unregisterForRemoteNotifications()
+            call.resolve()
+        }
+    }
+
     /**
      * Request notification permission
      */

diff --git a/push-notifications/src/definitions.ts b/push-notifications/src/definitions.ts
@@ -40,6 +40,15 @@ export interface PushNotificationsPlugin {
    */
   register(): Promise<void>;
 
+  /**
+   * Unregister the app from push notifications.
+   *
+   * This will delete a firebase token on Android, and unregister APNS on iOS.
+   *
+   * @since 5.0.0
+   */
+  unregister(): Promise<void>;
+
   /**
    * Get a list of notifications that are visible on the notifications screen.
    *