core/com.moengage.core.config/[androidJvm]TrackingOptOutConfig

TrackingOptOutConfig

@Serializable
data class TrackingOptOutConfig(val isCarrierTrackingEnabled: Boolean, val isDeviceAttributeTrackingEnabled: Boolean, val optOutActivities: List<String>, val screenNameTrackingConfig: ScreenNameTrackingConfig)

Create an instance of the tracking opt-out.

Since

Todo: Add Version

Parameters

isCarrierTrackingEnabled

true if you want the SDK to track the Carrier Name else false.

isDeviceAttributeTrackingEnabled

true if you want the SDK to track the device attributes, else false.

optOutActivities

list of activities class name which needs to excluded from tracking

screenNameTrackingConfig

Constructors

Link copied to clipboard
constructor(isCarrierTrackingEnabled: Boolean, isDeviceAttributeTrackingEnabled: Boolean, optOutActivities: Set<Class<*>>?, screenNameTrackingConfig: ScreenNameTrackingConfig)

Create an instance of the tracking opt-out.

constructor(isCarrierTrackingEnabled: Boolean, isDeviceAttributeTrackingEnabled: Boolean)
constructor(isCarrierTrackingEnabled: Boolean, isDeviceAttributeTrackingEnabled: Boolean, optOutActivities: Set<Class<*>>?)
constructor(isCarrierTrackingEnabled: Boolean, isDeviceAttributeTrackingEnabled: Boolean, optOutActivities: List<String>)

Create a instance of com.moengage.core.config.TrackingOptOutConfig with isCarrierTrackingEnabled, isDeviceAttributeTrackingEnabled and optedOutActivityNames

constructor(isCarrierTrackingEnabled: Boolean, isDeviceAttributeTrackingEnabled: Boolean, optOutActivities: List<String>, screenNameTrackingConfig: ScreenNameTrackingConfig)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val isCarrierTrackingEnabled: Boolean

If false the Mobile Carrier name would not be tracked by the SDK, default value true.

Link copied to clipboard
val isDeviceAttributeTrackingEnabled: Boolean

If false device attributes like Product name, Model Name, Height Width, etc are not tracked, the default value is true.

Link copied to clipboard
val optOutActivities: List<String>

List of Activity Class names to be excluded from tracking, default value empty set.

Link copied to clipboard
val screenNameTrackingConfig: ScreenNameTrackingConfig

ScreenName Tracking Configuration

Functions

Link copied to clipboard
fun addActivities(classNames: List<String>)

Add List of Activity Class to the opt-out list.

fun addActivities(clazzSet: Set<Class<*>>)

Add Set of Activity Class to the opt-out list.

Link copied to clipboard
fun addActivity(clazz: Class<*>)
fun addActivity(className: String)

Add Activity Class to the opt-out list.

Link copied to clipboard