MoEHelper

open class MoEHelper

Interaction class for MoEngage SDK. Has helper methods to track events and user attributes.

Author

MoEngage (abhishek@moengage.com)

Functions

logoutUser

open fun logoutUser()

Invalidates the existing sessions and user attributes and treats allactions performed by the user as a new user after this method is calledIf the Application is doing a self registration for gcm token then invalidate the token onlogout

registerActivityLifecycle

open fun registerActivityLifecycle(application: Application)

registerProcessLifecycleObserver

open fun registerProcessLifecycleObserver()

resetAppContext

open fun resetAppContext()

Resets the current context of the user

setAlias

open fun setAlias(currentId: Double)

since 11.0.

open fun setAlias(currentId: Int)

Update user's unique id which was previously set by setUniqueId

open fun setAlias(currentId: String)

Update user's unique id which was previously set by setUniqueId

open fun setAlias(currentId: Long)

Update user's unique id which was previously set by setUniqueId

setAppStatus

open fun setAppStatus(status: AppStatus)

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

setBirthDate

open fun setBirthDate(@NonNull() birthDate: Date)

Helper method to set User BirthDate

setEmail

open fun setEmail(@NonNull() value: String)

Helper method to set user email

setFirstName

open fun setFirstName(@NonNull() value: String)

Helper method to set User first Name

setFullName

open fun setFullName(@NonNull() value: String)

Helper method to set user full name

setGender

open fun setGender(@NonNull() gender: UserGender)

Helper method to set user gender

setLastName

open fun setLastName(@NonNull() value: String)

Helper method to set User Last Name

setNumber

open fun setNumber(value: String)

Helper method to set User Number

setUniqueId

open fun setUniqueId(value: Double)

Helper method to set User Unique Id

open fun setUniqueId(value: Float)

Helper method to set User Unique Id

open fun setUniqueId(value: Int)

Helper method to set User Unique Id

open fun setUniqueId(@NonNull() value: String)

Helper method to set User Unique Id

open fun setUniqueId(value: Long)

Helper method to set User Unique Id

setUserAttribute

open fun setUserAttribute(@NonNull() attributeMap: Map<String, Any>): MoEHelper

Set the user attributes with the attributes specified in the HashMap

open fun setUserAttribute(@NonNull() name: String, @NonNull() location: Location): MoEHelper

open fun setUserAttribute(@NonNull() name: String, @NonNull() location: GeoLocation): MoEHelper

open fun setUserAttribute(@NonNull() name: String, @NonNull() date: String, dateFormat: String): MoEHelper

open fun setUserAttribute(@NonNull() userAttribute: String, attributeValue: Boolean): MoEHelper

Set a user attribute for the current user

open fun setUserAttribute(@NonNull() userAttribute: String, attributeValue: Double): MoEHelper

Set a user attribute for the current user

open fun setUserAttribute(@NonNull() userAttribute: String, attributeValue: Float): MoEHelper

Set a user attribute for the current user

open fun setUserAttribute(@NonNull() userAttribute: String, attributeValue: Int): MoEHelper

Set a user attribute for the current user

open fun setUserAttribute(@NonNull() userAttribute: String, @NonNull() attributeValue: String): MoEHelper

Set an user attribute.

open fun setUserAttribute(@NonNull() name: String, @NonNull() value: Date): MoEHelper

Set a date user attribute for the current user.

open fun setUserAttribute(@NonNull() userAttribute: String, attributeValue: Long): MoEHelper

Set a user attribute for the current user

setUserAttributeEpochTime

open fun setUserAttributeEpochTime(@NonNull() userAttribute: String, attributeValue: Long): MoEHelper

Sets the given epoch time for the given user.

setUserAttributeISODate

open fun setUserAttributeISODate(@NonNull() attributeName: String, @NonNull() attributeValue: String): MoEHelper

Set a date type user attribute for the current user.

setUserLocation

open fun setUserLocation(lat: Double, lng: Double)

To set user location, call this method

syncInteractionDataNow

open fun syncInteractionDataNow()

Will request a data sync with MoEngage Platform.

trackDeviceLocale

open fun trackDeviceLocale()

Tracks device locale.

trackEvent

open fun trackEvent(@NonNull() action: String, payloadBuilder: PayloadBuilder): MoEHelper

open fun trackEvent(@NonNull() eventName: String, properties: Properties)

trackUserPushPreference

open fun trackUserPushPreference(pushPreference: Boolean)

Set push preference for the user.

unregisterLifecycleCallbacks

open fun unregisterLifecycleCallbacks(@NonNull() application: Application)

Method to unregister lifecycle callbacks

unRegisterProcessLifecycleObserver

open fun unRegisterProcessLifecycleObserver()

Properties

appContext

private open var appContext: List<String>

application

private open var application: Application

instance

private open var instance: MoEHelper