canRequestPermission is iOS only

OneSignal · Sep 26, 2023 · c503c99 · c503c99
1 parent 4189a99
commit c503c99
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 1 deletion.
diff --git a/MIGRATION_GUIDE.md b/MIGRATION_GUIDE.md
@@ -255,7 +255,7 @@ The Notifications namespace is accessible via `OneSignal.Notifications` and prov
 | **React Native**                       | **Description** |
 |--------------------------------------- | --------------- |
 | `OneSignal.Notifications.hasPermission()`                                                                      | _Whether this app has push notification permission._                                                                                                                                                                                                                                                                                                                                                                |
-| `await OneSignal.Notifications.canRequestPermission()`                                                               | _Whether attempting to request notification permission will show a prompt. Returns `true` if the device has not been prompted for push notification permission already._                                                                                                                                                                                                                                            |
+| `await OneSignal.Notifications.canRequestPermission()`                                                               | _(ios only) Whether attempting to request notification permission will show a prompt. Returns `true` if the device has not been prompted for push notification permission already._                                                                                                                                                                                                                                            |
 | `await OneSignal.Notifications.permissionNative()`                                                                   | _(ios only) Returns the enum for the native permission of the device. It will be one of: NotDetermined, Denied, Authorized, Provisional (only available in iOS 12), Ephemeral (only available in iOS 14)_                                                                                                                                                                                                           |
 | `OneSignal.Notifications.clearAll();`                                                                                | _Removes all OneSignal notifications._                                                                                                                                                                                                                                                                                                                                                                              |
 | `OneSignal.Notifications.removeNotification(32432)`                                                      | _(Android only) Cancels a single OneSignal notification based on its Android notification integer ID. Use instead of Android's [android.app.NotificationManager.cancel], otherwise the notification will be restored when your app is restarted._                                                                                                                                                                   |

diff --git a/android/src/main/java/com/onesignal/rnonesignalandroid/RNOneSignal.java b/android/src/main/java/com/onesignal/rnonesignalandroid/RNOneSignal.java
@@ -436,6 +436,7 @@ public void hasNotificationPermission(Promise promise) {
 
     @ReactMethod
     public void canRequestNotificationPermission(Promise promise) {
+        // iOS only method
         promise.resolve(true);
     }
 

diff --git a/src/index.ts b/src/index.ts
@@ -419,6 +419,7 @@ export namespace OneSignal {
     }
 
     /**
+     * iOS only.
      * Whether attempting to request notification permission will show a prompt. Returns true if the device has not been prompted for push
      * notification permission already.
      */