Merge pull request #1607 from OneSignal/add/notification_permission_prompting_callback_and_iam

[Add] notification permission prompting callback and In-App Message support

Author: jkasten2

Examples/OneSignalDemo/app/src/main/java/com/onesignal/sdktest/model/MainActivityViewModel.java

@@ -560,8 +560,17 @@ private void setupSubscriptionSwitch() {
 
         subscriptionSwitch.setOnClickListener(v -> {
             OneSignal.disablePush(!subscriptionSwitch.isChecked());
-            if (subscriptionSwitch.isChecked())
-                OneSignal.promptForPushNotifications(true);
+            if (subscriptionSwitch.isChecked()) {
+                OneSignal.promptForPushNotifications(
+                        true,
+                        new OneSignal.PromptForPushNotificationPermissionResponseHandler() {
+                            @Override
+                            public void response(boolean accepted) {
+                                System.out.println("APP promptForPushNotifications:" + this + ":accepted: " + accepted);
+                            }
+                        }
+                );
+            }
         });
     }
 

OneSignalSDK/onesignal/src/main/java/com/onesignal/NotificationPermissionController.kt

@@ -28,19 +28,42 @@
 package com.onesignal
 
 import android.os.Build
+import androidx.annotation.ChecksSdkIntAtLeast
 
 object NotificationPermissionController : PermissionsActivity.PermissionCallback {
     private const val PERMISSION_TYPE = "NOTIFICATION"
     private const val ANDROID_PERMISSION_STRING = "android.permission.POST_NOTIFICATIONS"
 
+    private val callbacks:
+            MutableSet<OneSignal.PromptForPushNotificationPermissionResponseHandler> = HashSet()
+
     init {
         PermissionsActivity.registerAsCallback(PERMISSION_TYPE, this)
     }
 
-    fun prompt(fallbackToSettings: Boolean) {
-        // TODO: Android 13 Beta 1 reports as 32 instead of 33, update to 33 once Google fixes this
-        if (Build.VERSION.SDK_INT < 32)
+    @ChecksSdkIntAtLeast(api = 33)
+    val supportsNativePrompt =
+        Build.VERSION.SDK_INT > 32 &&
+        OSUtils.getTargetSdkVersion(OneSignal.appContext) > 32
+
+    fun prompt(
+        fallbackToSettings: Boolean,
+        callback: OneSignal.PromptForPushNotificationPermissionResponseHandler?,
+    ) {
+        if (callback != null) callbacks.add(callback)
+
+        if (notificationsEnabled()) {
+            fireCallBacks(true)
+            return
+        }
+
+        if (!supportsNativePrompt) {
+            if (fallbackToSettings)
+                showFallbackAlertDialog()
+            else
+                fireCallBacks(false)
             return
+        }
 
         PermissionsActivity.startPrompt(
             fallbackToSettings,
@@ -52,14 +75,21 @@ object NotificationPermissionController : PermissionsActivity.PermissionCallback
 
     override fun onAccept() {
         OneSignal.refreshNotificationPermissionState()
+        fireCallBacks(true)
     }
 
     override fun onReject(fallbackToSettings: Boolean) {
-        if (fallbackToSettings) showFallbackAlertDialog()
+        val fallbackShown =
+            if (fallbackToSettings)
+                showFallbackAlertDialog()
+            else
+                false
+        if (!fallbackShown) fireCallBacks(false)
     }
 
-    private fun showFallbackAlertDialog() {
-        val activity = OneSignal.getCurrentActivity() ?: return
+    // Returns true if dialog was shown
+    private fun showFallbackAlertDialog(): Boolean {
+        val activity = OneSignal.getCurrentActivity() ?: return false
         AlertDialogPrepromptForAndroidSettings.show(
             activity,
             activity.getString(R.string.notification_permission_name_for_title),
@@ -69,8 +99,22 @@ object NotificationPermissionController : PermissionsActivity.PermissionCallback
                     NavigateToAndroidSettingsForNotifications.show(activity)
                 }
                 override fun onDecline() {
+                    fireCallBacks(false)
                 }
             }
         )
+        return true
     }
+
+    // Fires callbacks and clears them to ensure each is only called once.
+    private fun fireCallBacks(accepted: Boolean) {
+        callbacks.forEach { it.response(accepted) }
+        callbacks.clear()
+    }
+
+    fun onAppForegrounded() {
+        fireCallBacks(notificationsEnabled())
+    }
+
+    private fun notificationsEnabled() = OSUtils.areNotificationsEnabled(OneSignal.appContext)
 }

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSInAppMessageAction.java

@@ -10,8 +10,6 @@
 import java.util.ArrayList;
 import java.util.List;
 
-import static com.onesignal.OSInAppMessageLocationPrompt.LOCATION_PROMPT_KEY;
-
 public class OSInAppMessageAction {
 
     private static final String ID = "id";
@@ -117,8 +115,14 @@ private void parseOutcomes(JSONObject json) throws JSONException {
     private void parsePrompts(JSONObject json) throws JSONException {
         JSONArray promptsJsonArray = json.getJSONArray(PROMPTS);
         for (int i = 0; i < promptsJsonArray.length(); i++) {
-            if (promptsJsonArray.get(i).equals(LOCATION_PROMPT_KEY) ) {
-                prompts.add(new OSInAppMessageLocationPrompt());
+            String promptType = promptsJsonArray.getString(i);
+            switch (promptType) {
+                case OSInAppMessagePushPrompt.PUSH_PROMPT_KEY:
+                    prompts.add(new OSInAppMessagePushPrompt());
+                    break;
+                case OSInAppMessageLocationPrompt.LOCATION_PROMPT_KEY:
+                    prompts.add(new OSInAppMessageLocationPrompt());
+                    break;
             }
         }
     }

OneSignalSDK/onesignal/src/main/java/com/onesignal/OSInAppMessagePushPrompt.java

@@ -0,0 +1,25 @@
+package com.onesignal;
+
+public class OSInAppMessagePushPrompt extends OSInAppMessagePrompt {
+
+    static final String PUSH_PROMPT_KEY = "push";
+
+    @Override
+    void handlePrompt(OneSignal.OSPromptActionCompletionCallback callback) {
+        OneSignal.promptForPushNotifications(
+            true,
+            accepted -> {
+                OneSignal.PromptActionResult result = accepted ?
+                    OneSignal.PromptActionResult.PERMISSION_GRANTED :
+                    OneSignal.PromptActionResult.PERMISSION_DENIED;
+                callback.onCompleted(result);
+            }
+        );
+    }
+
+    @Override
+    String getPromptKey() {
+        return PUSH_PROMPT_KEY;
+    }
+
+}

OneSignalSDK/onesignal/src/main/java/com/onesignal/OneSignal.java

@@ -349,6 +349,13 @@ public interface PostNotificationResponseHandler {
       void onFailure(JSONObject response);
    }
 
+   /**
+    * Fires when the User accepts or declines the notification permission prompt.
+    */
+   public interface PromptForPushNotificationPermissionResponseHandler {
+      void response(boolean accepted);
+   }
+
    interface EntryStateListener {
       // Fire with the last appEntryState that just ended.
       void onEntryStateChange(AppEntryAction appEntryState);
@@ -1400,6 +1407,7 @@ static void onAppFocus() {
       }
 
       LocationController.onFocusChange();
+      NotificationPermissionController.INSTANCE.onAppForegrounded();
 
       if (OSUtils.shouldLogMissingAppIdError(appId))
          return;
@@ -2837,7 +2845,23 @@ public static void promptForPushNotifications() {
     *                           settings if they have declined before.
     */
    public static void promptForPushNotifications(boolean fallbackToSettings) {
-      NotificationPermissionController.INSTANCE.prompt(fallbackToSettings);
+      promptForPushNotifications(fallbackToSettings, null);
+   }
+
+   /**
+    * On Android 13 shows the system notification permission prompt to enable displaying
+    * notifications. This is required for apps that target Android API level 33 / "Tiramisu"
+    * to subscribe the device for push notifications.
+    *
+    * @param fallbackToSettings whether to show a Dialog to direct users to the App's notification
+    *                           settings if they have declined before.
+    * @param handler fires when the user declines ore accepts the notification permission prompt.
+    */
+   public static void promptForPushNotifications(
+      boolean fallbackToSettings,
+      @Nullable PromptForPushNotificationPermissionResponseHandler handler
+   ) {
+      NotificationPermissionController.INSTANCE.prompt(fallbackToSettings, handler);
    }
 
    /**