feat(PushNotifications): Make register method return if permission was granted (#2324)

Author: chrisweight

android/capacitor/src/main/java/com/getcapacitor/plugin/PushNotifications.java

@@ -104,7 +104,9 @@ public void onFailure(Exception e) {
         sendError(e.getLocalizedMessage());
       }
     });
-    call.success();
+    JSObject result = new JSObject();
+    result.put("granted", true);
+    call.success(result);
   }
 
   @PluginMethod()

core/src/core-plugin-definitions.ts

@@ -1486,8 +1486,12 @@ export interface PushNotificationChannelList {
   channels: PushNotificationChannel[];
 }
 
+export interface PushNotificationRegistrationResponse {
+  granted: boolean;
+}
+
 export interface PushNotificationsPlugin extends Plugin {
-  register(): Promise<void>;
+  register(): Promise<PushNotificationRegistrationResponse>;
   getDeliveredNotifications(): Promise<PushNotificationDeliveredList>;
   removeDeliveredNotifications(delivered: PushNotificationDeliveredList): Promise<void>;
   removeAllDeliveredNotifications(): Promise<void>;

ios/Capacitor/Capacitor/CAPUNUserNotificationCenterDelegate.swift

@@ -21,15 +21,17 @@ public class CAPUNUserNotificationCenterDelegate : NSObject, UNUserNotificationC
   /**
    * Request permissions to send notifications
    */
-  public func requestPermissions() {
+  public func requestPermissions(with completion: ((Bool, Error?) -> Void)? = nil) {
     // Override point for customization after application launch.
     let center = UNUserNotificationCenter.current()
     center.requestAuthorization(options:[.badge, .alert, .sound]) { (granted, error) in
-      // Enable or disable features based on authorization.
-    }
+        if granted {
+            DispatchQueue.main.async {
+              UIApplication.shared.registerForRemoteNotifications()
+            }
+        }
 
-    DispatchQueue.main.async {
-      UIApplication.shared.registerForRemoteNotifications()
+        completion?(granted, error)
     }
   }
 

ios/Capacitor/Capacitor/Plugins/PushNotifications.swift

@@ -13,7 +13,7 @@ public class CAPPushNotificationsPlugin : CAPPlugin {
   // Local list of notification id -> JSObject for storing options
   // between notification requets
   var notificationRequestLookup = [String:JSObject]()
-  
+
   public override func load() {
     NotificationCenter.default.addObserver(self, selector: #selector(self.didRegisterForRemoteNotificationsWithDeviceToken(notification:)), name: Notification.Name(CAPNotifications.DidRegisterForRemoteNotificationsWithDeviceToken.name()), object: nil)
     NotificationCenter.default.addObserver(self, selector: #selector(self.didFailToRegisterForRemoteNotificationsWithError(notification:)), name: Notification.Name(CAPNotifications.DidFailToRegisterForRemoteNotificationsWithError.name()), object: nil)
@@ -23,8 +23,14 @@ public class CAPPushNotificationsPlugin : CAPPlugin {
    * Register for push notifications
    */
   @objc func register(_ call: CAPPluginCall) {
-    self.bridge.notificationsDelegate.requestPermissions()
-    call.success()
+    self.bridge.notificationsDelegate.requestPermissions() { granted, error in
+        guard error == nil else {
+            call.error(error!.localizedDescription)
+            return
+        }
+
+        call.success(["granted": granted])
+    }
   }
 
   /**
@@ -40,7 +46,7 @@ public class CAPPushNotificationsPlugin : CAPPlugin {
       ])
     })
   }
-  
+
   /**
    * Remove specified notifications from Notification Center
    */
@@ -78,7 +84,7 @@ public class CAPPushNotificationsPlugin : CAPPlugin {
   @objc func listChannels(_ call: CAPPluginCall) {
     call.unimplemented()
   }
-  
+
   @objc public func didRegisterForRemoteNotificationsWithDeviceToken(notification: NSNotification){
     if let deviceToken = notification.object as? Data {
       let deviceTokenString = deviceToken.reduce("", {$0 + String(format: "%02X", $1)})

site/src/assets/docs-content/apis/push-notifications/api.html

@@ -66,13 +66,13 @@ <h3 class="avc-code-method-header" id="method-listChannels-0">listChannels</h3>
 <div class="avc-code-method">
                     <h3 class="avc-code-method-header" id="method-register-0">register</h3>
                     <div class="avc-code-method-signature">
-                      <span class="avc-code-method-name">register</span><span class="avc-code-paren">(</span><span class="avc-code-paren">)</span><span class="avc-code-return-type-colon">:</span> Promise<span class="avc-code-typearg-bracket">&lt;</span>void<span class="avc-code-typearg-bracket">&gt;</span>
+                      <span class="avc-code-method-name">register</span><span class="avc-code-paren">(</span><span class="avc-code-paren">)</span><span class="avc-code-return-type-colon">:</span> Promise<span class="avc-code-typearg-bracket">&lt;</span><avc-code-type type-id="861">PushNotificationRegistrationResponse</avc-code-type><span class="avc-code-typearg-bracket">&gt;</span>
     </div>
 
   <div class="avc-code-method-params">
 
   <div class="avc-code-method-returns-info">
-    <span class="avc-code-method-returns-label">Returns:</span> Promise<span class="avc-code-typearg-bracket">&lt;</span>void<span class="avc-code-typearg-bracket">&gt;</span>
+    <span class="avc-code-method-returns-label">Returns:</span> Promise<span class="avc-code-typearg-bracket">&lt;</span><avc-code-type type-id="861">PushNotificationRegistrationResponse</avc-code-type><span class="avc-code-typearg-bracket">&gt;</span>
   </div>
 
 </div></div>