core/com.moengage.core/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(@NonNull listener: AppBackgroundListener)

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

fun addAppBackgroundListener(@NonNull appId: String, @NonNull listener: AppBackgroundListener)

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

Link copied to clipboard
fun addLogoutCompleteListener(@NonNull listener: OnLogoutCompleteListener)

Add a listener to get a callback on logout complete for the account configured as default

fun addLogoutCompleteListener(@NonNull appId: String, @NonNull listener: OnLogoutCompleteListener)

Add a listener to get a callback on logout complete for the given instance.

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(@NonNull bundle: Bundle): String?

Returns the account identifier in the payload if present.

Link copied to clipboard
fun getInstanceIdentifierFromMap(@NonNull 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(@NonNull context: Context)

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

fun logoutUser(@NonNull context: Context, @NonNull appId: String)

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

Link copied to clipboard
fun registerPreProcessingListener(@NonNull appId: String, @NonNull 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(@NonNull listener: AppBackgroundListener)

Remove application background listener for the account configured as default.

fun removeAppBackgroundListener(@NonNull appId: String, @NonNull listener: AppBackgroundListener)

Remove application background listener for the given account.

Link copied to clipboard
fun removeLogoutListener(@NonNull listener: OnLogoutCompleteListener)

Remove logout listener for the account configured as default.

fun removeLogoutListener(@NonNull appId: String, @NonNull 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(@NonNull context: Context)

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

fun syncInteractionData(@NonNull context: Context, @NonNull appId: String)

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

Link copied to clipboard
fun unRegisterPreProcessingListener(@NonNull appId: String, @NonNull 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