core/com.moengage.core.analytics/MoEAnalyticsHelper

MoEAnalyticsHelper

object MoEAnalyticsHelper

Helper class to track data on the MoEngage Platform.

Author

Umang Chamaria

Since

12.0.00

Functions

getUserIdentities

@WorkerThread

fun getUserIdentities(context: Context, workspaceId: String? = null): Map<String, String>?

Identities of the user that has been set.

identifyUser

@JvmOverloads

fun identifyUser(context: Context, identity: String, workspaceId: String? = null): MoETask<UserIdentityResult>

@JvmOverloads

fun identifyUser(context: Context, identity: Map<String, String>, workspaceId: String? = null): MoETask<UserIdentitiesResult>

Identify the user with the given identifiers.

setAlias

fun ~~setAlias~~(context: Context, alias: Any)

fun ~~setAlias~~(context: Context, alias: Any, appId: String)

Set an Alias to update the existing Unique Id Note: This API only accepts the below data-types:

setAppStatus

@JvmOverloads

fun setAppStatus(context: Context, status: AppStatus, appId: String? = null): MoETask<AppStatusResult>

This API tells the SDK whether it is a fresh install or an existing application was updated.

setBirthDate

fun setBirthDate(context: Context, birthDate: Date): MoETask<UserAttributeResult.Standard>

Helper method to set User's Birth Date.

fun setBirthDate(context: Context, isoDate: String): MoETask<UserAttributeResult.ISODate>

fun setBirthDate(context: Context, isoDate: String, appId: String): MoETask<UserAttributeResult.ISODate>

Helper method to set user's Birth Date. Supported format - yyyy-MM-dd|yyyyMMdd[T(hh:mm[:ss.sss]|hhmm[ss.sss])]?[Z|+-hh:mm]]

fun setBirthDate(context: Context, birthDate: Date, appId: String): MoETask<UserAttributeResult.Standard>

Helper method to set User BirthDate

setDeviceAttribute

@JvmOverloads

fun setDeviceAttribute(context: Context, attributeName: String, attributeValue: Any, workspaceId: String? = null): MoETask<DeviceAttributeResult>

Set device attribute for the given workspace id instance (if null, then default instance). Supported value data types are:

setEmailId

fun setEmailId(context: Context, value: String): MoETask<UserAttributeResult.Standard>

fun setEmailId(context: Context, value: String, appId: String): MoETask<UserAttributeResult.Standard>

Helper method to set user email

setFirstName

fun setFirstName(context: Context, value: String): MoETask<UserAttributeResult.Standard>

fun setFirstName(context: Context, value: String, appId: String): MoETask<UserAttributeResult.Standard>

Helper method to set User first Name

setGender

fun setGender(context: Context, gender: UserGender): MoETask<UserAttributeResult.Standard>

fun setGender(context: Context, gender: UserGender, appId: String): MoETask<UserAttributeResult.Standard>

Helper method to set user gender

setLastName

fun setLastName(context: Context, value: String): MoETask<UserAttributeResult.Standard>

fun setLastName(context: Context, value: String, appId: String): MoETask<UserAttributeResult.Standard>

Helper method to set User Last Name

setLocation

@JvmOverloads

fun setLocation(context: Context, lat: Double, lng: Double, appId: String? = null, attributeLevel: UserAttributeLevel = UserAttributeLevel.PROJECT): MoETask<UserAttributeResult.Standard>

Track user location as a User Attribute

setMobileNumber

fun setMobileNumber(context: Context, value: String): MoETask<UserAttributeResult.Standard>

fun setMobileNumber(context: Context, value: String, appId: String): MoETask<UserAttributeResult.Standard>

Helper method to set User Number

setUniqueId

fun ~~setUniqueId~~(context: Context, uniqueId: Any)

fun ~~setUniqueId~~(context: Context, uniqueId: Any, appId: String)

Set an Unique Identifier for the user.

setUserAttribute

@JvmOverloads

fun setUserAttribute(context: Context, attributes: Map<String, Any>, appId: String? = null, attributeLevel: UserAttributeLevel = UserAttributeLevel.PROJECT): MoETask<UserAttributeResult.Bulk>

Set the user attributes with the attributes specified in the HashMap

@JvmOverloads

fun setUserAttribute(context: Context, attributeName: String, attributeValue: Any, appId: String? = null, attributeLevel: UserAttributeLevel = UserAttributeLevel.PROJECT): MoETask<UserAttributeResult.Standard>

Track a user attribute in the default instance.

setUserAttributeEpochTime

@JvmOverloads

fun setUserAttributeEpochTime(context: Context, name: String, value: Long, appId: String? = null, attributeLevel: UserAttributeLevel = UserAttributeLevel.PROJECT): MoETask<UserAttributeResult.EpochTime>

Sets the given epoch time for the given user.

setUserAttributeISODate

@JvmOverloads

fun setUserAttributeISODate(context: Context, attributeName: String, attributeValue: String, appId: String? = null, attributeLevel: UserAttributeLevel = UserAttributeLevel.PROJECT): MoETask<UserAttributeResult.ISODate>

Set a date type user attribute for the current user.

setUserName

fun setUserName(context: Context, value: String): MoETask<UserAttributeResult.Standard>

fun setUserName(context: Context, value: String, appId: String): MoETask<UserAttributeResult.Standard>

Helper method to set user full name

trackDeviceLocale

fun trackDeviceLocale(context: Context): MoETask<DeviceLocaleResult>

fun trackDeviceLocale(context: Context, appId: String): MoETask<DeviceLocaleResult>

Tracks device locale.

trackEvent

fun trackEvent(context: Context, eventName: String, properties: Properties): MoETask<TrackEventResult>

fun trackEvent(context: Context, eventName: String, properties: Properties, appId: String): MoETask<TrackEventResult>

Track user behaviour as events with properties.

trackUserPushPreference

fun trackUserPushPreference(context: Context, pushPreference: Boolean): MoETask<UserAttributeResult.Standard>

fun trackUserPushPreference(context: Context, pushPreference: Boolean, appId: String): MoETask<UserAttributeResult.Standard>

Set user's push preference.