core/com.moengage.core

Package-level declarations

Types

enum DataCenter : Enum<DataCenter>

enum DataCenter : Enum<DataCenter>

enum DataCenter : Enum<DataCenter>

Supported Data Centers

@Retention(value = SOURCE)

annotation class LogLevel

@Retention(value = SOURCE)

annotation class LogLevel

@Retention(value = SOURCE)

annotation class LogLevel

Supported Log levels

object MoECoreHelper

object MoECoreHelper

object MoECoreHelper

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

Initialise MoEngage SDK using this class.

class Properties

class Properties

class Properties

A helper class for building attributes

Properties

MOENGAGE_ACCOUNT_IDENTIFIER

const val MOENGAGE_ACCOUNT_IDENTIFIER: String

const val MOENGAGE_ACCOUNT_IDENTIFIER: String

const val MOENGAGE_ACCOUNT_IDENTIFIER: String

Key used for MoEngage Account Identifier in campaign payloads and intent extras.

PUSH_NOTIFICATION_ANIMATED_IMAGE_URL

const val PUSH_NOTIFICATION_ANIMATED_IMAGE_URL: String

const val PUSH_NOTIFICATION_ANIMATED_IMAGE_URL: String

const val PUSH_NOTIFICATION_ANIMATED_IMAGE_URL: String

Key used for animated image in the Push Campaign.

PUSH_NOTIFICATION_CAMPAIGN_ID

const val PUSH_NOTIFICATION_CAMPAIGN_ID: String

const val PUSH_NOTIFICATION_CAMPAIGN_ID: String

const val PUSH_NOTIFICATION_CAMPAIGN_ID: String

Key used for unique campaign identifier in the Push Campaign.

PUSH_NOTIFICATION_COUPON_CODE

const val PUSH_NOTIFICATION_COUPON_CODE: String

const val PUSH_NOTIFICATION_COUPON_CODE: String

const val PUSH_NOTIFICATION_COUPON_CODE: String

Key used for coupon code in the Push Campaign.

PUSH_NOTIFICATION_FROM_MOENGAGE

const val PUSH_NOTIFICATION_FROM_MOENGAGE: String

const val PUSH_NOTIFICATION_FROM_MOENGAGE: String

const val PUSH_NOTIFICATION_FROM_MOENGAGE: String

Key used for identifying sending platform in the Push Campaign.

PUSH_NOTIFICATION_IMAGE_URL

const val PUSH_NOTIFICATION_IMAGE_URL: String

const val PUSH_NOTIFICATION_IMAGE_URL: String

const val PUSH_NOTIFICATION_IMAGE_URL: String

Key used for image in the Push Campaign.

PUSH_NOTIFICATION_MESSAGE

const val PUSH_NOTIFICATION_MESSAGE: String

const val PUSH_NOTIFICATION_MESSAGE: String

const val PUSH_NOTIFICATION_MESSAGE: String

Key used for notification message in the Push Campaign.

PUSH_NOTIFICATION_MOENGAGE_CONFIRMATION_VALUE

const val PUSH_NOTIFICATION_MOENGAGE_CONFIRMATION_VALUE: String

const val PUSH_NOTIFICATION_MOENGAGE_CONFIRMATION_VALUE: String

const val PUSH_NOTIFICATION_MOENGAGE_CONFIRMATION_VALUE: String

Value for identifying Push Campaign from MoEngage platform.

PUSH_NOTIFICATION_NAVIGATION_ACTIVITY_NAME

const val PUSH_NOTIFICATION_NAVIGATION_ACTIVITY_NAME: String

const val PUSH_NOTIFICATION_NAVIGATION_ACTIVITY_NAME: String

const val PUSH_NOTIFICATION_NAVIGATION_ACTIVITY_NAME: String

Key used for screen name or activity name in the Push Campaign.

PUSH_NOTIFICATION_NAVIGATION_DEEPLINK

const val PUSH_NOTIFICATION_NAVIGATION_DEEPLINK: String

const val PUSH_NOTIFICATION_NAVIGATION_DEEPLINK: String

const val PUSH_NOTIFICATION_NAVIGATION_DEEPLINK: String

Key used for deeplink in the Push Campaign.

PUSH_NOTIFICATION_NAVIGATION_DEEPLINK_LEGACY

const val PUSH_NOTIFICATION_NAVIGATION_DEEPLINK_LEGACY: String

const val PUSH_NOTIFICATION_NAVIGATION_DEEPLINK_LEGACY: String

const val PUSH_NOTIFICATION_NAVIGATION_DEEPLINK_LEGACY: String

Key used for legacy deeplink in the Push Campaign.

PUSH_NOTIFICATION_SHOW_DIALOG

const val PUSH_NOTIFICATION_SHOW_DIALOG: String

const val PUSH_NOTIFICATION_SHOW_DIALOG: String

const val PUSH_NOTIFICATION_SHOW_DIALOG: String

PUSH_NOTIFICATION_SUMMARY

const val PUSH_NOTIFICATION_SUMMARY: String

const val PUSH_NOTIFICATION_SUMMARY: String

const val PUSH_NOTIFICATION_SUMMARY: String

Key used for notification summary in the Push Campaign.

PUSH_NOTIFICATION_TITLE

const val PUSH_NOTIFICATION_TITLE: String

const val PUSH_NOTIFICATION_TITLE: String

const val PUSH_NOTIFICATION_TITLE: String

Key used for notification title in the Push Campaign.

PUSH_NOTIFICATION_TYPE

const val PUSH_NOTIFICATION_TYPE: String

const val PUSH_NOTIFICATION_TYPE: String

const val PUSH_NOTIFICATION_TYPE: String

Key used for type of notification in the Push Campaign.

PUSH_NOTIFICATION_TYPE_DEEP_LINK_NOTIFICATION

const val PUSH_NOTIFICATION_TYPE_DEEP_LINK_NOTIFICATION: String

const val PUSH_NOTIFICATION_TYPE_DEEP_LINK_NOTIFICATION: String

const val PUSH_NOTIFICATION_TYPE_DEEP_LINK_NOTIFICATION: String

Value for notification type when the navigation has deeplink or http(s) url in the Push Campaign.

PUSH_NOTIFICATION_TYPE_NORMAL_NOTIFICATION

const val PUSH_NOTIFICATION_TYPE_NORMAL_NOTIFICATION: String

const val PUSH_NOTIFICATION_TYPE_NORMAL_NOTIFICATION: String

const val PUSH_NOTIFICATION_TYPE_NORMAL_NOTIFICATION: String

Value for notification type when navigation has screen name in the Push Campaign.

PUSH_NOTIFICATION_TYPE_SILENT_NOTIFICATION

const val PUSH_NOTIFICATION_TYPE_SILENT_NOTIFICATION: String

const val PUSH_NOTIFICATION_TYPE_SILENT_NOTIFICATION: String

const val PUSH_NOTIFICATION_TYPE_SILENT_NOTIFICATION: String

Value for notification type for Silent notification.

Functions

buildProperties

fun buildProperties(block: Properties.() -> Unit): Properties

fun buildProperties(block: Properties.() -> Unit): Properties

fun buildProperties(block: Properties.() -> Unit): Properties

A helper method to build Properties

configureJavascriptUsage

fun configureJavascriptUsage(config: JavaScriptConfig)

fun configureJavascriptUsage(config: JavaScriptConfig)

fun configureJavascriptUsage(config: JavaScriptConfig)

API to configure Javascript usage in WebView

disableAdIdTracking

fun disableAdIdTracking(context: Context)

fun disableAdIdTracking(context: Context)

fun disableAdIdTracking(context: Context)

API to disable Advertising Id tracking for the account configured as default.

fun disableAdIdTracking(context: Context, appId: String)

fun disableAdIdTracking(context: Context, appId: String)

fun disableAdIdTracking(context: Context, appId: String)

API to disable Advertising Id tracking for the given instance.

fun disableAllLogs()

fun disableAllLogs()

fun disableAllLogs()

API to completely disable SDK related logs.

disableAndroidIdTracking

fun disableAndroidIdTracking(context: Context)

fun disableAndroidIdTracking(context: Context)

fun disableAndroidIdTracking(context: Context)

API to disable Android-id tracking for the account configured as default.

fun disableAndroidIdTracking(context: Context, appId: String)

fun disableAndroidIdTracking(context: Context, appId: String)

fun disableAndroidIdTracking(context: Context, appId: String)

API to disable Android-id tracking for the given instance.

disableDataTracking

fun disableDataTracking(context: Context)

fun disableDataTracking(context: Context)

fun disableDataTracking(context: Context)

fun disableDataTracking(context: Context, appId: String)

fun disableDataTracking(context: Context, appId: String)

fun disableDataTracking(context: Context, appId: String)

Optionally opt-out of data tracking. When data tracking is opted out no custom event or user attribute is tracked on MoEngage Platform.

disableDeviceIdTracking

fun disableDeviceIdTracking(context: Context, appId: String? = null)

fun disableDeviceIdTracking(context: Context, appId: String? = null)

fun disableDeviceIdTracking(context: Context, appId: String? = null)

Disables Device-id tracking.

disableIntegrationValidator

fun disableIntegrationValidator()

fun disableIntegrationValidator()

fun disableIntegrationValidator()

Disable Integration validator in debug build to avoid MoEngage SDK throwing exception to Application

fun disableSdk(context: Context)

fun disableSdk(context: Context)

fun disableSdk(context: Context)

API to disable all features of the SDK for the account configured as default.

fun disableSdk(context: Context, appId: String)

fun disableSdk(context: Context, appId: String)

fun disableSdk(context: Context, appId: String)

API to disable all features of the SDK.

enableAdIdTracking

fun enableAdIdTracking(context: Context)

fun enableAdIdTracking(context: Context)

fun enableAdIdTracking(context: Context)

API to enable Advertising Id tracking for the account configured as default.

fun enableAdIdTracking(context: Context, appId: String)

fun enableAdIdTracking(context: Context, appId: String)

fun enableAdIdTracking(context: Context, appId: String)

API to enable Advertising Id tracking for the given instance.

fun enableAllLogs()

fun enableAllLogs()

fun enableAllLogs()

API to enable the common logs in release build which are not specific to any AppId.

enableAndroidIdTracking

fun enableAndroidIdTracking(context: Context)

fun enableAndroidIdTracking(context: Context)

fun enableAndroidIdTracking(context: Context)

API to enable Android-id tracking for the account configured as default.

fun enableAndroidIdTracking(context: Context, appId: String)

fun enableAndroidIdTracking(context: Context, appId: String)

fun enableAndroidIdTracking(context: Context, appId: String)

API to enable Android-id tracking for the given instance.

enableDataTracking

fun enableDataTracking(context: Context)

fun enableDataTracking(context: Context)

fun enableDataTracking(context: Context)

fun enableDataTracking(context: Context, appId: String)

fun enableDataTracking(context: Context, appId: String)

fun enableDataTracking(context: Context, appId: String)

API to enable data tracking.

enableDeviceIdTracking

fun enableDeviceIdTracking(context: Context, appId: String? = null)

fun enableDeviceIdTracking(context: Context, appId: String? = null)

fun enableDeviceIdTracking(context: Context, appId: String? = null)

Enable Device-id tracking. It is enabled by default, should be called only if tracking is disabled at some point.

fun enableSdk(context: Context)

fun enableSdk(context: Context)

fun enableSdk(context: Context)

API to enable SDK usage for the account configured as default.

fun enableSdk(context: Context, appId: String)

fun enableSdk(context: Context, appId: String)

fun enableSdk(context: Context, appId: String)

API to enable SDK usage for the given account.

isAppBackground

fun isAppBackground(): Boolean

fun isAppBackground(): Boolean

fun isAppBackground(): Boolean

Returns if the application is in foreground or background.

isAppForeground

fun isAppForeground(): Boolean

fun isAppForeground(): Boolean

fun isAppForeground(): Boolean

Returns if the application is in foreground or background.

fun isSdkEnabled(context: Context, appId: String? = null): Boolean

fun isSdkEnabled(context: Context, appId: String? = null): Boolean

fun isSdkEnabled(context: Context, appId: String? = null): Boolean

Returns the current state of the SDK, i.e. whether it is enabled or disabled. Optionally pass in the account identifier to get the status for a specific account. If you only have the default instance configured appId parameter can be ignored.

isSdkInitialised

fun isSdkInitialised(): Boolean

fun isSdkInitialised(): Boolean

fun isSdkInitialised(): Boolean

Checks if the SDK is initialised post current process creation with any account marked as default.

fun isSdkInitialised(appId: String): Boolean

fun isSdkInitialised(appId: String): Boolean

fun isSdkInitialised(appId: String): Boolean

Checks if the SDK is initialised post current process creation with the specified account identifier.