feat: improve push click behavior

samples/java_layout/src/main/java/io/customer/android/sample/java_layout/ui/common/SimpleFragmentActivity.java

@@ -4,10 +4,12 @@
 import android.os.Bundle;
 import android.text.TextUtils;
 
+import androidx.annotation.Nullable;
 import androidx.fragment.app.Fragment;
 import androidx.fragment.app.FragmentManager;
 import androidx.fragment.app.FragmentTransaction;
 
+import io.customer.android.sample.java_layout.R;
 import io.customer.android.sample.java_layout.databinding.ActivitySimpleFragmentBinding;
 import io.customer.android.sample.java_layout.ui.core.BaseActivity;
 import io.customer.android.sample.java_layout.ui.dashboard.DashboardActivity;
@@ -16,8 +18,9 @@
 import io.customer.android.sample.java_layout.ui.tracking.CustomEventTrackingFragment;
 import io.customer.android.sample.java_layout.ui.user.AuthViewModel;
 import io.customer.android.sample.java_layout.utils.ViewUtils;
+import io.customer.sdk.tracking.TrackableScreen;
 
-public class SimpleFragmentActivity extends BaseActivity<ActivitySimpleFragmentBinding> {
+public class SimpleFragmentActivity extends BaseActivity<ActivitySimpleFragmentBinding> implements TrackableScreen {
 
     public static final String FRAGMENT_CUSTOM_TRACKING_EVENT = "FRAGMENT_CUSTOM_TRACKING_EVENT";
     public static final String FRAGMENT_DEVICE_ATTRIBUTES = "FRAGMENT_DEVICE_ATTRIBUTES";
@@ -34,6 +37,24 @@ public static Bundle getExtras(String fragmentName) {
         return extras;
     }
 
+    @Nullable
+    @Override
+    public String getScreenName() {
+        switch (mFragmentName) {
+            case FRAGMENT_CUSTOM_TRACKING_EVENT:
+                return getString(R.string.screen_label_custom_event);
+
+            case FRAGMENT_DEVICE_ATTRIBUTES:
+                return getString(R.string.screen_label_device_attributes);
+
+            case FRAGMENT_PROFILE_ATTRIBUTES:
+                return getString(R.string.screen_label_profile_attributes);
+
+            default:
+                return null;
+        }
+    }
+
     @Override
     protected ActivitySimpleFragmentBinding inflateViewBinding() {
         return ActivitySimpleFragmentBinding.inflate(getLayoutInflater());

samples/java_layout/src/main/java/io/customer/android/sample/java_layout/ui/dashboard/DashboardActivity.java

@@ -13,6 +13,7 @@
 
 import androidx.activity.result.ActivityResultLauncher;
 import androidx.activity.result.contract.ActivityResultContracts;
+import androidx.annotation.Nullable;
 import androidx.annotation.RequiresApi;
 import androidx.annotation.StringRes;
 import androidx.core.app.NotificationManagerCompat;
@@ -34,8 +35,9 @@
 import io.customer.android.sample.java_layout.ui.user.AuthViewModel;
 import io.customer.android.sample.java_layout.utils.Randoms;
 import io.customer.android.sample.java_layout.utils.ViewUtils;
+import io.customer.sdk.tracking.TrackableScreen;
 
-public class DashboardActivity extends BaseActivity<ActivityDashboardBinding> {
+public class DashboardActivity extends BaseActivity<ActivityDashboardBinding> implements TrackableScreen {
 
     private AuthViewModel authViewModel;
     private CustomerIORepository customerIORepository;
@@ -56,6 +58,12 @@ public class DashboardActivity extends BaseActivity<ActivityDashboardBinding> {
                 }
             });
 
+    @Nullable
+    @Override
+    public String getScreenName() {
+        return getString(R.string.screen_label_dashboard);
+    }
+
     @Override
     protected ActivityDashboardBinding inflateViewBinding() {
         return ActivityDashboardBinding.inflate(getLayoutInflater());

samples/java_layout/src/main/res/values/strings.xml

@@ -60,4 +60,8 @@
     <string name="error_text_input_field_empty">This field cannot be empty</string>
     <string name="error_number_input_field_small">The value must be greater than or equal to %1$s</string>
     <string name="token_copied">Token Copied!</string>
+    <string name="screen_label_dashboard">Dashboard</string>
+    <string name="screen_label_custom_event">Custom Event</string>
+    <string name="screen_label_device_attributes">Custom Device Attribute</string>
+    <string name="screen_label_profile_attributes">Custom Profile Attribute</string>
 </resources>

sdk/api/sdk.api

@@ -373,3 +373,7 @@ public abstract interface class io/customer/sdk/repository/preference/SitePrefer
 	public abstract fun setHttpRequestsPauseEnds (Ljava/util/Date;)V
 }
 
+public abstract interface class io/customer/sdk/tracking/TrackableScreen {
+	public abstract fun getScreenName ()Ljava/lang/String;
+}
+

sdk/src/main/java/io/customer/sdk/CustomerIO.kt

@@ -20,6 +20,7 @@
 import io.customer.sdk.repository.TrackRepository
 import io.customer.sdk.repository.preference.CustomerIOStoredValues
 import io.customer.sdk.repository.preference.doesExist
+import io.customer.sdk.tracking.TrackableScreen
 import io.customer.sdk.util.CioLogLevel
 import io.customer.sdk.util.Seconds
 import kotlinx.coroutines.CoroutineScope
@@ -545,17 +546,25 @@
 
     private fun recordScreenViews(activity: Activity, attributes: CustomAttributes) {
         val packageManager = activity.packageManager
-        return try {
-            val info = packageManager.getActivityInfo(
-                activity.componentName,
-                PackageManager.GET_META_DATA
-            )
-            val activityLabel = info.loadLabel(packageManager)
-
-            val screenName = activityLabel.toString().ifEmpty {
-                activity::class.java.simpleName.getScreenNameFromActivity()
+        try {
+            val screenName: String? = if (activity is TrackableScreen) {
+                // TrackableScreen takes precedence over manifest label
+                activity.getScreenName()
+            } else {
+                val info = packageManager.getActivityInfo(
+                    activity.componentName,
+                    PackageManager.GET_META_DATA
+                )
+                val activityLabel = info.loadLabel(packageManager)
+
+                activityLabel.toString().ifEmpty {
+                    activity::class.java.simpleName.getScreenNameFromActivity()
+                }
+            }
+            // If screen name is null, we do not track the screen
+            screenName?.let {
+                screen(screenName, attributes)
             }
-            screen(screenName, attributes)
         } catch (e: PackageManager.NameNotFoundException) {
             // if `PackageManager.NameNotFoundException` is thrown, is that a bug in the SDK or a problem with the customer's app?
             // We may want to decide to log this as an SDK error, log it so customer notices it to fix it themselves, or we do nothing because this exception might not be a big issue.

sdk/src/main/java/io/customer/sdk/tracking/TrackableScreen.kt

@@ -0,0 +1,14 @@
+package io.customer.sdk.tracking
+
+/**
+ * Optional interface for activities that should be tracked using automated screen tracking.
+ */
+interface TrackableScreen {
+    /**
+     * Retrieve the name that should be used for tracking the screen. This name
+     * should be unique for each screen.
+     *
+     * @return name for tracking the screen, or null if the screen shouldn't be tracked.
+     */
+    fun getScreenName(): String?
+}