core/com.moengage.core/[androidJvm]MoECoreHelper

MoECoreHelper

object MoECoreHelper

Helper class to access the core APIs for the MoEngage SDK.

Since

12.0.00

Author

Umang Chamaria

Functions

Link copied to clipboard
fun addAppBackgroundListener(listener: AppBackgroundListener)

Add a listener to get a callback on application background for the account configured as default.

fun addAppBackgroundListener(appId: String, listener: AppBackgroundListener)

Add a listener to get a callback on application background for the given account.

Link copied to clipboard
fun addLogoutCompleteListener(listener: OnLogoutCompleteListener)

Add a listener to get a callback on logout complete for the account configured as default. A strong reference of the listener is maintained, so do register it in your activity/fragment/service and remove it when not required.

fun addLogoutCompleteListener(appId: String, listener: OnLogoutCompleteListener)

Add a listener to get a callback on logout complete for the given instance. A strong reference of the listener is maintained, so do register it in your activity/fragment/service and remove it when not required.

Link copied to clipboard
fun addSDKInitialisedListener(appId: String, listener: SDKInitialisedListener)

Add a listener to get a callback when the SDK is initialised for the given app ID

Link copied to clipboard
fun deleteUser(context: Context, listener: UserDeletionListener)

Delete Current User Data From MoEngage Server for the account configured as default.

fun deleteUser(context: Context, appId: String, listener: UserDeletionListener)

Delete Current User Data From MoEngage Server for the given instance

Link copied to clipboard
fun getInstanceIdentifierFromBundle(bundle: Bundle): String?

Returns the account identifier in the payload if present.

Link copied to clipboard
fun getInstanceIdentifierFromMap(map: Map<String, String>): String?

Returns the account identifier in the payload if present.

Link copied to clipboard
fun getMoEngageDeviceId(context: Context, listener: OnDeviceIdAvailableListener)
fun getMoEngageDeviceId(context: Context, appId: String, listener: OnDeviceIdAvailableListener)

Fetches unique ID generated by the MoEngage SDK.

Link copied to clipboard
fun getUserRegistrationStatus(context: Context): UserRegistrationStatus
fun getUserRegistrationStatus(context: Context, appId: String): UserRegistrationStatus

Returns the User registration state

Link copied to clipboard
fun logoutUser(context: Context)

Notify the SDK that the user has logged out of the application for the account configured as default

fun logoutUser(context: Context, appId: String)

Notify the SDK that the user has logged out of the application for the given instance.

Link copied to clipboard
@JvmOverloads
fun passAuthenticationDetails(context: Context, details: AuthenticationData, workspaceId: String? = null)

Passes the JWT token to the SDK for authentication.

Link copied to clipboard
@JvmOverloads
fun registerAuthenticationListener(listener: OnAuthenticationError?, workspaceId: String? = null)

Registers a listener to get a callback when there is an authentication error. Pass null to remove/reset the listener. Register the listener in the global scope to ensure the application receives the callback irrespective of where the user is in the application. For example in the onCreate() of the Application class.

Link copied to clipboard
fun registerPreProcessingListener(appId: String, listener: IntentPreProcessingListener)

Add a listener to get a callback the SDK tries to process an incoming intent.

Link copied to clipboard
fun registerUser(context: Context, data: String, listener: UserRegistrationListener)
fun registerUser(context: Context, appId: String, data: String, listener: UserRegistrationListener)

Registers the User

Link copied to clipboard
fun removeAppBackgroundListener(listener: AppBackgroundListener)

Remove application background listener for the account configured as default.

fun removeAppBackgroundListener(appId: String, listener: AppBackgroundListener)

Remove application background listener for the given account.

Link copied to clipboard
fun removeLogoutListener(listener: OnLogoutCompleteListener)

Remove logout listener for the account configured as default.

fun removeLogoutListener(appId: String, listener: OnLogoutCompleteListener)

Remove logout listener for the given account.

Link copied to clipboard
fun removeSDKInitialisedListener(appId: String, listener: SDKInitialisedListener)

Remove the listener set to get a callback when the SDK is initialised for the given app ID

Link copied to clipboard
@JvmOverloads
fun setupSdkForBackgroundMode(context: Context, appId: String? = null)

Setup the MoEngage Sdk to work in Background even if user has not opened the application.

Link copied to clipboard
fun syncInteractionData(context: Context)

Immediately sync tracked data with MoEngage Server for the account configured as default.

fun syncInteractionData(context: Context, appId: String)

Immediately sync tracked data with MoEngage Server for the given account.

Link copied to clipboard
fun unRegisterPreProcessingListener(appId: String, listener: IntentPreProcessingListener)

Remove listener to get a callback the SDK tries to process an incoming intent.

Link copied to clipboard
fun unregisterUser(context: Context, data: String, listener: UserRegistrationListener)
fun unregisterUser(context: Context, appId: String, data: String, listener: UserRegistrationListener)

UnRegisters the User