Package-level declarations

Types

Link copied to clipboard

Supported Data Centers

Link copied to clipboard
@Retention(value = SOURCE)
annotation class LogLevel
@Retention(value = SOURCE)
annotation class LogLevel
@Retention(value = SOURCE)
annotation class LogLevel
Supported Log levels
Link copied to clipboard

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

Link copied to clipboard
class MoEngage
class MoEngage
class MoEngage

Initialise MoEngage SDK using this class.

Link copied to clipboard

A helper class for building attributes

Properties

Link copied to clipboard

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

Link copied to clipboard

Key used for unique campaign identifier in the Push Campaign.

Link copied to clipboard

Key used for coupon code in the Push Campaign.

Link copied to clipboard

Key used for identifying sending platform in the Push Campaign.

Link copied to clipboard

Key used for image in the Push Campaign.

Link copied to clipboard

Key used for notification message in the Push Campaign.

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

Link copied to clipboard

Key used for notification summary in the Push Campaign.

Link copied to clipboard

Key used for notification title in the Push Campaign.

Link copied to clipboard

Key used for type of notification in the Push Campaign.

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

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

Functions

Link copied to clipboard

API to configure Javascript usage in WebView

Link copied to clipboard

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.

Link copied to clipboard

API to completely disable SDK related logs.

Link copied to clipboard

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

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

Link copied to clipboard

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

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

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

API to enable data tracking.

Link copied to clipboard
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.

Link copied to clipboard
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.

Link copied to clipboard

Returns if the application is in foreground or background.

Link copied to clipboard

Returns if the application is in foreground or background.

Link copied to clipboard
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.

Link copied to clipboard

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

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