AB#277632 - Overlay messaging

CHANGELOG.md

@@ -1,12 +1,16 @@
 # Changelog
 
+## 7.13.0
+
+- Implementation for Overlay Messaging channel. Check optimove developer docs for more.
+
 ## 7.12.3
 
--  Wraps `isLaunchActivity()` in try/catch and safely returns false on failure to prevent crashes.
+- Wraps `isLaunchActivity()` in try/catch and safely returns false on failure to prevent crashes.
 
 ## 7.12.2
 
--  Introduces a lastShownByInterceptorId field that tracks which message was last shown through the interceptor, preventing duplicate interception of the same head message.
+- Introduces a lastShownByInterceptorId field that tracks which message was last shown through the interceptor, preventing duplicate interception of the same head message.
 
 ## 7.12.1
 
@@ -18,12 +22,10 @@
 
 - Fixed dismissed in-app messages re-appearing on fast consecutive app foregrounds
 
-
 ## 7.11.1
 
 - Fix: expiryDate is always absent in EmbeddedMessage due to inconsistent format given by v2 endpoint
 
-
 ## 7.11.0
 
 - Updated delayed configuration to no longer require a redundant region parameter. Region is now inferred from credentials. Deprecated `OptimoveConfig.Builder(Region, FeatureSet)` — use `Builder(FeatureSet)` instead.
@@ -32,7 +34,6 @@
 
 - Minor bug fixes for Embedded Messaging: correct field mapping
 
-
 ## 7.10.1
 
 - Bumped GSON version number to fix a vulnerability issue
@@ -52,7 +53,8 @@
 
 ## 7.8.0
 
-Add In-App Message Interceptor API `OptimoveInApp.getInstance().setInAppMessageInterceptor`, basic usage: 
+Add In-App Message Interceptor API `OptimoveInApp.getInstance().setInAppMessageInterceptor`, basic usage:
+
 ```java
 OptimoveInApp.getInstance().setInAppMessageInterceptor((message, decision) -> {
   // Example: decide based on your own logic

OptimoveSDK/app/src/main/java/com/optimove/android/optimovemobilesdk/MainActivity.kt

@@ -55,7 +55,10 @@ class MainActivity : AppCompatActivity() {
         super.onCreate(savedInstanceState)
 
         OptimoveInApp.getInstance().setDeepLinkHandler(object : InAppDeepLinkHandlerInterface {
-            override fun handle(context: android.content.Context, buttonPress: InAppDeepLinkHandlerInterface.InAppButtonPress) {
+            override fun handle(
+                context: android.content.Context,
+                buttonPress: InAppDeepLinkHandlerInterface.InAppButtonPress
+            ) {
                 Log.d(TAG, "DeepLink handler invoked")
                 startActivity(Intent(this@MainActivity, MainActivity::class.java))
             }
@@ -64,10 +67,18 @@ class MainActivity : AppCompatActivity() {
         val config = Optimove.getConfig()
         val showPreferenceCenter = config.isPreferenceCenterConfigured
         val showEmbeddedMessaging = config.isEmbeddedMessagingConfigured
+        val showOverlayMessaging = config.isOverlayMessagingEnabled
         val showDelayedConfig = config.usesDelayedConfiguration()
 
-        if (ContextCompat.checkSelfPermission(this, Manifest.permission.WRITE_EXTERNAL_STORAGE) != PackageManager.PERMISSION_GRANTED) {
-            ActivityCompat.requestPermissions(this, arrayOf(Manifest.permission.WRITE_EXTERNAL_STORAGE), WRITE_EXTERNAL_PERMISSION_REQUEST_CODE)
+        if (ContextCompat.checkSelfPermission(
+                this, Manifest.permission.WRITE_EXTERNAL_STORAGE
+            ) != PackageManager.PERMISSION_GRANTED
+        ) {
+            ActivityCompat.requestPermissions(
+                this,
+                arrayOf(Manifest.permission.WRITE_EXTERNAL_STORAGE),
+                WRITE_EXTERNAL_PERMISSION_REQUEST_CODE
+            )
         }
 
         Optimove.getInstance().seeIntent(intent, savedInstanceState)
@@ -86,6 +97,7 @@ class MainActivity : AppCompatActivity() {
                     outputText = outputText,
                     showPreferenceCenter = showPreferenceCenter,
                     showEmbeddedMessaging = showEmbeddedMessaging,
+                    showOverlayMessaging = showOverlayMessaging,
                     showDelayedConfig = showDelayedConfig,
                     credentialsSubmitted = credentialsSubmitted,
                     isInterceptingInApp = isInterceptingInApp,
@@ -104,6 +116,7 @@ class MainActivity : AppCompatActivity() {
                     onGetPreferences = ::getPreferences,
                     onSetPreferences = ::setPreferences,
                     onViewEmbeddedMessaging = ::viewEmbeddedMessaging,
+                    onViewOverlayMessaging = ::viewOverlayMessaging,
                     onSetCredentials = ::setCredentials,
                     onInAppInterceptionClicked = ::onInAppInterceptionClicked,
                     onSendLocation = { lat, lng ->
@@ -118,12 +131,14 @@ class MainActivity : AppCompatActivity() {
                     onResetToken = {},
                     onOpenDeeplinkTest = ::openDeeplinkTest,
                     onRegisterPush = {
-                        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU &&
-                            ContextCompat.checkSelfPermission(this@MainActivity, Manifest.permission.POST_NOTIFICATIONS)
-                                == PackageManager.PERMISSION_DENIED &&
-                            !shouldShowRequestPermissionRationale(Manifest.permission.POST_NOTIFICATIONS)
+                        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU && ContextCompat.checkSelfPermission(
+                                this@MainActivity, Manifest.permission.POST_NOTIFICATIONS
+                            ) == PackageManager.PERMISSION_DENIED && !shouldShowRequestPermissionRationale(
+                                Manifest.permission.POST_NOTIFICATIONS
+                            )
                         ) {
-                            outputText = "Notification permission permanently denied. Opening settings..."
+                            outputText =
+                                "Notification permission permanently denied. Opening settings..."
                             startActivity(Intent(Settings.ACTION_APP_NOTIFICATION_SETTINGS).apply {
                                 putExtra(Settings.EXTRA_APP_PACKAGE, this@MainActivity.packageName)
                             })
@@ -142,12 +157,9 @@ class MainActivity : AppCompatActivity() {
                     onDelayedInitToggle = { enabled ->
                         isDelayedInit = enabled
                         qaPrefs.edit().putBoolean(MyApplication.KEY_DELAYED_INIT, enabled).apply()
-                        outputText = if (enabled)
-                            "Delayed init enabled — restart app to apply"
-                        else
-                            "Immediate init enabled — restart app to apply"
-                    }
-                )
+                        outputText = if (enabled) "Delayed init enabled — restart app to apply"
+                        else "Immediate init enabled — restart app to apply"
+                    })
             }
         }
     }
@@ -222,30 +234,27 @@ class MainActivity : AppCompatActivity() {
                 outputText = "Calling setUserId"
                 Optimove.getInstance().setUserId(userId)
             }
+
             userId.isEmpty() -> {
                 outputText = "Calling setUserEmail"
                 Optimove.getInstance().setUserEmail(userEmail)
             }
+
             else -> {
                 outputText = "Calling registerUser"
                 Optimove.getInstance().registerUser(userId, userEmail)
             }
         }
-        identityPrefs.edit()
-            .putString(KEY_USER_ID, userId)
-            .putString(KEY_USER_EMAIL, userEmail)
+        identityPrefs.edit().putString(KEY_USER_ID, userId).putString(KEY_USER_EMAIL, userEmail)
             .apply()
     }
 
     private fun clearIdentity() {
-        identityPrefs.edit()
-            .remove(KEY_USER_ID)
-            .remove(KEY_USER_EMAIL)
-            .apply()
+        identityPrefs.edit().remove(KEY_USER_ID).remove(KEY_USER_EMAIL).apply()
         persistedUserId = ""
         persistedUserEmail = ""
         outputText = "Identity cleared (saved values removed)"
-    } 
+    }
 
     private fun readInbox() {
         val items = OptimoveInApp.getInstance().inboxItems
@@ -272,18 +281,21 @@ class MainActivity : AppCompatActivity() {
         items.forEach { OptimoveInApp.getInstance().deleteMessageFromInbox(it) }
     }
 
+
     private fun getPreferences() {
         OptimovePreferenceCenter.getInstance().getPreferencesAsync { result, preferences ->
             when (result) {
-                OptimovePreferenceCenter.ResultType.ERROR_USER_NOT_SET,
-                OptimovePreferenceCenter.ResultType.ERROR,
-                OptimovePreferenceCenter.ResultType.ERROR_CREDENTIALS_NOT_SET -> Log.d(PC_TAG, result.toString())
+                OptimovePreferenceCenter.ResultType.ERROR_USER_NOT_SET, OptimovePreferenceCenter.ResultType.ERROR, OptimovePreferenceCenter.ResultType.ERROR_CREDENTIALS_NOT_SET -> Log.d(
+                    PC_TAG, result.toString()
+                )
+
                 OptimovePreferenceCenter.ResultType.SUCCESS -> preferences?.let { prefs ->
                     Log.d(PC_TAG, "configured: ${prefs.configuredChannels}")
                     prefs.customerPreferences.forEach { topic ->
                         Log.d(PC_TAG, "${topic.id} ${topic.name} ${topic.subscribedChannels}")
                     }
                 }
+
                 else -> Log.d(PC_TAG, "unknown res type")
             }
         }
@@ -292,9 +304,10 @@ class MainActivity : AppCompatActivity() {
     private fun setPreferences() {
         OptimovePreferenceCenter.getInstance().getPreferencesAsync { result, preferences ->
             when (result) {
-                OptimovePreferenceCenter.ResultType.ERROR_USER_NOT_SET,
-                OptimovePreferenceCenter.ResultType.ERROR,
-                OptimovePreferenceCenter.ResultType.ERROR_CREDENTIALS_NOT_SET -> Log.d(PC_TAG, result.toString())
+                OptimovePreferenceCenter.ResultType.ERROR_USER_NOT_SET, OptimovePreferenceCenter.ResultType.ERROR, OptimovePreferenceCenter.ResultType.ERROR_CREDENTIALS_NOT_SET -> Log.d(
+                    PC_TAG, result.toString()
+                )
+
                 OptimovePreferenceCenter.ResultType.SUCCESS -> preferences?.let { prefs ->
                     Log.d(PC_TAG, "loaded prefs for set: good")
                     val configuredChannels: List<Channel> = prefs.configuredChannels
@@ -303,10 +316,10 @@ class MainActivity : AppCompatActivity() {
                         PreferenceUpdate(topic.id, configuredChannels.subList(0, 1))
                     }
                     OptimovePreferenceCenter.getInstance().setCustomerPreferencesAsync(
-                        { setResult -> Log.d(PC_TAG, setResult.toString()) },
-                        updates
+                        { setResult -> Log.d(PC_TAG, setResult.toString()) }, updates
                     )
                 }
+
                 else -> Log.d(PC_TAG, "unknown res type")
             }
         }
@@ -316,8 +329,16 @@ class MainActivity : AppCompatActivity() {
         startActivity(Intent(this, EmbeddedMessagingActivity::class.java))
     }
 
+    private fun viewOverlayMessaging() {
+        startActivity(Intent(this, OverlayMessagingActivity::class.java))
+    }
+
     private fun openDeeplinkTest() {
-        startActivity(Intent(Intent.ACTION_VIEW, Uri.parse(DeeplinkTargetActivity.DEEPLINK_TEST_URI)))
+        startActivity(
+            Intent(
+                Intent.ACTION_VIEW, Uri.parse(DeeplinkTargetActivity.DEEPLINK_TEST_URI)
+            )
+        )
     }
 
     private fun setCredentials(optimove: String?, optimobile: String?, prefCenter: String?) {
@@ -348,19 +369,18 @@ class MainActivity : AppCompatActivity() {
         val options = arrayOf("Default (5000 ms)", "12,000 ms")
         var selected = 0
 
-        AlertDialog.Builder(this)
-            .setTitle("Enable In-App Interception")
+        AlertDialog.Builder(this).setTitle("Enable In-App Interception")
             .setSingleChoiceItems(options, 0) { _, which -> selected = which }
             .setPositiveButton("Enable") { d, _ ->
                 val timeoutMs = if (selected == 0) 5000L else 12000L
                 enableInAppInterception(timeoutMs)
                 isInterceptingInApp = true
+
                 outputText = "In-App interception enabled ($timeoutMs ms timeout per message)"
                 Toast.makeText(this, "In-App interception enabled ($timeoutMs ms)", Toast.LENGTH_SHORT).show()
+
                 d.dismiss()
-            }
-            .setNegativeButton("Cancel", null)
-            .show()
+            }.setNegativeButton("Cancel", null).show()
     }
 
     private fun disableInAppInterception() {
@@ -373,10 +393,13 @@ class MainActivity : AppCompatActivity() {
 
     private fun enableInAppInterception(timeoutMs: Long) {
         OptimoveInApp.getInstance().setInAppMessageInterceptor(object : InAppMessageInterceptor {
-            override fun processMessage(messageData: JSONObject?, decision: InAppMessageInterceptorCallback) {
+            override fun processMessage(
+                messageData: JSONObject?, decision: InAppMessageInterceptorCallback
+            ) {
                 runOnUiThread {
                     inAppDecisionDialog?.takeIf { it.isShowing }?.dismiss()
                     val dataText = messageData?.toString() ?: "No data provided"
+
                     inAppDecisionDialog = AlertDialog.Builder(this@MainActivity)
                         .setTitle("QA: In-App Message")
                         .setMessage("$dataText\nChoose Show, Postpone, or Suppress.")
@@ -394,6 +417,7 @@ class MainActivity : AppCompatActivity() {
                         }
                         .setOnCancelListener { decision.suppress() }
                         .create()
+
                     inAppDecisionDialog?.show()
                 }
             }
@@ -405,8 +429,7 @@ class MainActivity : AppCompatActivity() {
     private class SimpleCustomEvent : OptimoveEvent() {
         override fun getName(): String = "Simple cUSTOM_Event     "
         override fun getParameters(): Map<String, Any> = mapOf(
-            "strinG_param" to "  some_string  ",
-            "number_param" to 42
+            "strinG_param" to "  some_string  ", "number_param" to 42
         )
     }