capacitor-moengage-core

MoEngage is a mobile marketing automation company. This capacitor SDK helps you track events, trigger smart notifications.

Install

npm install capacitor-moengage-core
npx cap sync

API

• initialize(...)
• trackEvent(...)
• setUniqueId(...)
• setAlias(...)
• setUserName(...)
• setFirstName(...)
• setLastName(...)
• setEmailId(...)
• setMobileNumber(...)
• setBirthDate(...)
• setGender(...)
• setUserLocation(...)
• setUserAttribute(...)
• setUserAttributeDate(...)
• setUserAttributeLocation(...)
• setAppStatus(...)
• logoutUser(...)
• enableSdk(...)
• disableSdk(...)
• showInApp(...)
• getSelfHandledInApp(...)
• selfHandledShown(...)
• selfHandledClicked(...)
• selfHandledDismissed(...)
• setInAppContext(...)
• resetInAppContext(...)
• enableDataTracking(...)
• disableDataTracking(...)
• passFcmPushToken(...)
• passFcmPushPayload(...)
• registerForPush()
• onOrientationChanged()
• addListener('pushTokenGenerated', ...)
• addListener('pushClicked', ...)
• addListener('inAppCampaignShown', ...)
• addListener('inAppCampaignClicked', ...)
• addListener('inAppCampaignDismissed', ...)
• addListener('inAppCampaignCustomAction', ...)
• addListener('inAppCampaignSelfHandled', ...)
• enableAdIdTracking(...)
• disableAdIdTracking(...)
• enableAndroidIdTracking(...)
• disableAndroidIdTracking(...)
• setupNotificationChannelsAndroid()
• pushPermissionResponseAndroid(...)
• navigateToSettingsAndroid()
• requestPushPermissionAndroid()
• addListener('onPermissionResult', ...)
• enableDeviceIdTracking(...)
• disableDeviceIdTracking(...)
• updatePushPermissionRequestCountAndroid(...)
• deleteUser(...)
• Interfaces
• Type Aliases
• Enums

initialize(...)

initialize(options: { appId: string; }) => Promise<void>

Initialise MoEngage Capacitor Plugin

| Param | Type | | ------------- | ------------------------------- | | options | { appId: string; } |

Since: 2.0.0

trackEvent(...)

trackEvent(options: { eventName: string; eventAttributes?: MoEProperties; appId: string; }) => Promise<void>

Track user behaviour as events with properties

| Param | Type | | ------------- | ---------------------------------------------------------------------------------------------------------------- | | options | { eventName: string; eventAttributes?: MoEProperties; appId: string; } |

Since: 2.0.0

setUniqueId(...)

setUniqueId(options: { uniqueId: string; appId: string; }) => Promise<void>

Set a Unique Identifier for the user.

| Param | Type | | ------------- | ------------------------------------------------- | | options | { uniqueId: string; appId: string; } |

Since: 2.0.0

setAlias(...)

setAlias(options: { alias: string; appId: string; }) => Promise<void>

Set an Alias to update the existing Unique Id

| Param | Type | | ------------- | ---------------------------------------------- | | options | { alias: string; appId: string; } |

Since: 2.0.0

setUserName(...)

setUserName(options: { userName: string; appId: string; }) => Promise<void>

Set user's full name

| Param | Type | | ------------- | ------------------------------------------------- | | options | { userName: string; appId: string; } |

Since: 2.0.0

setFirstName(...)

setFirstName(options: { firstName: string; appId: string; }) => Promise<void>

Set user's first name

| Param | Type | | ------------- | -------------------------------------------------- | | options | { firstName: string; appId: string; } |

Since: 2.0.0

setLastName(...)

setLastName(options: { lastName: string; appId: string; }) => Promise<void>

Set user's last name

| Param | Type | | ------------- | ------------------------------------------------- | | options | { lastName: string; appId: string; } |

setEmailId(...)

setEmailId(options: { emailId: string; appId: string; }) => Promise<void>

Set user's email id

| Param | Type | | ------------- | ------------------------------------------------ | | options | { emailId: string; appId: string; } |

Since: 2.0.0

setMobileNumber(...)

setMobileNumber(options: { mobileNumber: string; appId: string; }) => Promise<void>

Set user's mobile number

| Param | Type | | ------------- | ----------------------------------------------------- | | options | { mobileNumber: string; appId: string; } |

setBirthDate(...)

setBirthDate(options: { birthdate: string; appId: string; }) => Promise<void>

Set user's birthdate.

| Param | Type | | ------------- | -------------------------------------------------- | | options | { birthdate: string; appId: string; } |

Since: 1.0.0

setGender(...)

setGender(options: { gender: MoEUserGender; appId: string; }) => Promise<void>

Set user's gender.

| Param | Type | | ------------- | ----------------------------------------------------------------------------------- | | options | { gender: MoEUserGender; appId: string; } |

Since: 2.0.0

setUserLocation(...)

setUserLocation(options: { location: MoEGeoLocation; appId: string; }) => Promise<void>

Set user's location

| Param | Type | | ------------- | --------------------------------------------------------------------------------------- | | options | { location: MoEGeoLocation; appId: string; } |

Since: 2.0.0

setUserAttribute(...)

setUserAttribute(options: { name: string; value: string | number | boolean | Array<string> | Array<number>; appId: string; }) => Promise<void>

Set the user defined attribute with value.

| Param | Type | | ------------- | --------------------------------------------------------------------------------------------------------- | | options | { name: string; value: string | number | boolean | string[] | number[]; appId: string; } |

Since: 2.0.0

setUserAttributeDate(...)

setUserAttributeDate(options: { name: string; value: string; appId: string; }) => Promise<void>

Set a user attribute timestamp for the current user

| Param | Type | | ------------- | ------------------------------------------------------------ | | options | { name: string; value: string; appId: string; } |

Since: 2.0.0

setUserAttributeLocation(...)

setUserAttributeLocation(options: { name: string; location: MoEGeoLocation; appId: string; }) => Promise<void>

Set the user attribute location

| Param | Type | | ------------- | ----------------------------------------------------------------------------------------------------- | | options | { name: string; location: MoEGeoLocation; appId: string; } |

Since: 2.0.0

setAppStatus(...)

setAppStatus(options: { appStatus: MoEAppStatus; appId: string; }) => Promise<void>

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

| Param | Type | | ------------- | ------------------------------------------------------------------------------------ | | options | { appStatus: MoEAppStatus; appId: string; } |

Since: 2.0.0

logoutUser(...)

logoutUser(options: { appId: string; }) => Promise<void>

Notify the SDK that the user has logged out of the application

| Param | Type | | ------------- | ------------------------------- | | options | { appId: string; } |

Since: 2.0.0

enableSdk(...)

enableSdk(options: { appId: string; }) => Promise<void>

API to enable SDK usage.

| Param | Type | | ------------- | ------------------------------- | | options | { appId: string; } |

Since: 2.0.0

disableSdk(...)

disableSdk(options: { appId: string; }) => Promise<void>

API to disable all features of the SDK.

| Param | Type | | ------------- | ------------------------------- | | options | { appId: string; } |

Since: 2.0.0

showInApp(...)

showInApp(options: { appId: string; }) => Promise<void>

Call this method wherever InApp message has to be shown, if available.

| Param | Type | | ------------- | ------------------------------- | | options | { appId: string; } |

Since: 2.0.0

getSelfHandledInApp(...)

getSelfHandledInApp(options: { appId: string; }) => Promise<void>

Triggers fetching self handled in-app, the result is returned in the inAppCampaignSelfHandled listener

| Param | Type | | ------------- | ------------------------------- | | options | { appId: string; } |

Since: 2.0.0

selfHandledShown(...)

selfHandledShown(campaignData: MoEInAppSelfHandledCampaignData) => Promise<void>

API to track self handled in-app shown event.

| Param | Type | Description | | ------------------ | ------------------------------------------------------------------------------------------- | --------------- | | campaignData | MoEInAppSelfHandledCampaignData | in-app campaign |

Since: 2.0.0

selfHandledClicked(...)

selfHandledClicked(campaignData: MoEInAppSelfHandledCampaignData) => Promise<void>

API to track click event of any other widget apart from primary widget in the self handled in-app.

| Param | Type | Description | | ------------------ | ------------------------------------------------------------------------------------------- | --------------- | | campaignData | MoEInAppSelfHandledCampaignData | in-app campaign |

Since: 2.0.0

selfHandledDismissed(...)

selfHandledDismissed(campaignData: MoEInAppSelfHandledCampaignData) => Promise<void>

API to track self handled in-app's dismiss event.

| Param | Type | Description | | ------------------ | ------------------------------------------------------------------------------------------- | --------------- | | campaignData | MoEInAppSelfHandledCampaignData | in-app campaign |

Since: 2.0.0

setInAppContext(...)

setInAppContext(options: { contexts: Array<string>; appId: string; }) => Promise<void>

Set current context for in-app module.

| Param | Type | | ------------- | --------------------------------------------------- | | options | { contexts: string[]; appId: string; } |

Since: 2.0.0

resetInAppContext(...)

resetInAppContext(options: { appId: string; }) => Promise<void>

Resets/Clears the previously set context for in-app module.

| Param | Type | | ------------- | ------------------------------- | | options | { appId: string; } |

Since: 2.0.0

enableDataTracking(...)

enableDataTracking(options: { appId: string; }) => Promise<void>

Optionally opt-in data tracking.

| Param | Type | | ------------- | ------------------------------- | | options | { appId: string; } |

Since: 2.0.0

disableDataTracking(...)

disableDataTracking(options: { appId: string; }) => Promise<void>

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

| Param | Type | | ------------- | ------------------------------- | | options | { appId: string; } |

Since: 2.0.0

passFcmPushToken(...)

passFcmPushToken(options: { token: string; appId: string; }) => Promise<void>

Pass FCM Push Token to the MoEngage SDK

| Param | Type | | ------------- | ---------------------------------------------- | | options | { token: string; appId: string; } |

Since: 2.0.0

passFcmPushPayload(...)

passFcmPushPayload(options: { payload: object; appId: string; }) => Promise<void>

Pass FCM payload to MoEngage SDK

| Param | Type | | ------------- | ------------------------------------------------ | | options | { payload: object; appId: string; } |

Since: 2.0.0

registerForPush()

registerForPush() => Promise<void>

Register For Push Notification for iOS

Since: 2.0.0

onOrientationChanged()

onOrientationChanged() => Promise<void>

Notifies MoEngage SDK of device orientation change

Since: 2.0.0

addListener('pushTokenGenerated', ...)

addListener(eventName: 'pushTokenGenerated', listenerFunc: MoEPushTokenListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for push token generated event

| Param | Type | | ------------------ | --------------------------------------------------------------------- | | eventName | 'pushTokenGenerated' | | listenerFunc | MoEPushTokenListener |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 2.0.0

addListener('pushClicked', ...)

addListener(eventName: 'pushClicked', listenerFunc: MoEPushClickListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for push clicked event

| Param | Type | | ------------------ | --------------------------------------------------------------------- | | eventName | 'pushClicked' | | listenerFunc | MoEPushClickListener |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 1.0.0

addListener('inAppCampaignShown', ...)

addListener(eventName: 'inAppCampaignShown', listenerFunc: MoEInAppShownListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for in-app campaign shown event

| Param | Type | | ------------------ | ----------------------------------------------------------------------- | | eventName | 'inAppCampaignShown' | | listenerFunc | MoEInAppShownListener |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 1.0.0

addListener('inAppCampaignClicked', ...)

addListener(eventName: 'inAppCampaignClicked', listenerFunc: MoEInAppClickedListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for in-app campaign clicked event

| Param | Type | | ------------------ | --------------------------------------------------------------------------- | | eventName | 'inAppCampaignClicked' | | listenerFunc | MoEInAppClickedListener |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 1.0.0

addListener('inAppCampaignDismissed', ...)

addListener(eventName: 'inAppCampaignDismissed', listenerFunc: MoEInAppDismissedListener) => Promise<PluginListenerHandle> & PluginListenerHandle

| Param | Type | | ------------------ | ------------------------------------------------------------------------------- | | eventName | 'inAppCampaignDismissed' | | listenerFunc | MoEInAppDismissedListener |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

addListener('inAppCampaignCustomAction', ...)

addListener(eventName: 'inAppCampaignCustomAction', listenerFunc: MoEInAppCustomActionListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for in-app campaign custom action event

| Param | Type | | ------------------ | ------------------------------------------------------------------------------------- | | eventName | 'inAppCampaignCustomAction' | | listenerFunc | MoEInAppCustomActionListener |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 1.0.0

addListener('inAppCampaignSelfHandled', ...)

addListener(eventName: 'inAppCampaignSelfHandled', listenerFunc: MoEInAppSelfHandledListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for in-app campaign self handled available event

getSelfHandledInApp() api call returns the available self handled in-app via this listener.

| Param | Type | | ------------------ | ----------------------------------------------------------------------------------- | | eventName | 'inAppCampaignSelfHandled' | | listenerFunc | MoEInAppSelfHandledListener |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 1.0.0

enableAdIdTracking(...)

enableAdIdTracking(options: { appId: string; }) => Promise<void>

Enables GAID tracking, by default GAID tracking is disabled.

| Param | Type | | ------------- | ------------------------------- | | options | { appId: string; } |

Since: 2.0.0

disableAdIdTracking(...)

disableAdIdTracking(options: { appId: string; }) => Promise<void>

Disables GAID tracking.

| Param | Type | | ------------- | ------------------------------- | | options | { appId: string; } |

Since: 2.0.0

enableAndroidIdTracking(...)

enableAndroidIdTracking(options: { appId: string; }) => Promise<void>

Enables Android ID tracking, by default ANdroid ID tracking is disabled.

| Param | Type | | ------------- | ------------------------------- | | options | { appId: string; } |

Since: 2.0.0

disableAndroidIdTracking(...)

disableAndroidIdTracking(options: { appId: string; }) => Promise<void>

Disables Android ID tracking.

| Param | Type | | ------------- | ------------------------------- | | options | { appId: string; } |

Since: 2.0.0

setupNotificationChannelsAndroid()

setupNotificationChannelsAndroid() => Promise<void>

API to create notification channels on Android.

Since: 2.0.0

pushPermissionResponseAndroid(...)

pushPermissionResponseAndroid(options: { isGranted: boolean; }) => Promise<void>

Notify the SDK on notification permission granted to the application.

| Param | Type | | ------------- | ------------------------------------ | | options | { isGranted: boolean; } |

Since: 2.0.0

navigateToSettingsAndroid()

navigateToSettingsAndroid() => Promise<void>

Navigates the user to the Notification settings on Android 8 or above, on older versions the user is navigated the application settings or application info screen.

requestPushPermissionAndroid()

requestPushPermissionAndroid() => Promise<void>

Requests the push permission on Android 13 and above.

addListener('onPermissionResult', ...)

addListener(eventName: 'onPermissionResult', listenerFunc: MoEPermissionListener) => Promise<PluginListenerHandle> & PluginListenerHandle

Listen for permission response

| Param | Type | | ------------------ | ----------------------------------------------------------------------- | | eventName | 'onPermissionResult' | | listenerFunc | MoEPermissionListener |

Returns: Promise<PluginListenerHandle> & PluginListenerHandle

Since: 2.0.0

enableDeviceIdTracking(...)

enableDeviceIdTracking(options: { appId: string; }) => Promise<void>

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

| Param | Type | | ------------- | ------------------------------- | | options | { appId: string; } |

disableDeviceIdTracking(...)

disableDeviceIdTracking(options: { appId: string; }) => Promise<void>

Disables Device-id tracking.

| Param | Type | | ------------- | ------------------------------- | | options | { appId: string; } |

updatePushPermissionRequestCountAndroid(...)

updatePushPermissionRequestCountAndroid(options: { appId: string; count: number; }) => Promise<void>

Updates the Notification request attempt count, the request attempt count will be incremented by the passed fresh count.

NOTE: Call this API only when the Application is handling the Notification request permission.

| Param | Type | | ------------- | ---------------------------------------------- | | options | { appId: string; count: number; } |

deleteUser(...)

deleteUser(options: { appId: string; }, callback: MoEUserDeleteCallback) => Promise<void>

Delete Current User Data From MoEngage Server

| Param | Type | Description | | -------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | | options | { appId: string; } | | | callback | MoEUserDeleteCallback | instance of {@link MoEUserDeleteCallback} to get the API response |

Interfaces

MoEProperties

User attributes object

| Prop | Type | Description | | ------------------------ | --------------------------------------------------------------------------------------------------------- | ---------------------------- | | generalAttributes | Array<MoEGeneralAttributes> | General Attributes | | dateTimeAttributes | Array<MoEDateTimeAttributes> | Location Attributes | | locationAttributes | Array<MoELocationAttributes> | Date time Attributes | | isNonInteractive | boolean | Is the event non-interactive |

Array

| Prop | Type | Description | | ------------ | ------------------- | ------------------------------------------------------------------------------------------------------ | | length | number | Gets or sets the length of the array. This is a number one higher than the highest index in the array. |

| Method | Signature | Description | | ------------------ | ----------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | toString | () => string | Returns a string representation of an array. | | toLocaleString | () => string | Returns a string representation of an array. The elements are converted to string using their toLocalString methods. | | pop | () => T | undefined | Removes the last element from an array and returns it. If the array is empty, undefined is returned and the array is not modified. | | push | (...items: T[]) => number | Appends new elements to the end of an array, and returns the new length of the array. | | concat | (...items: ConcatArray<T>[]) => T[] | Combines two or more arrays. This method returns a new array without modifying any existing arrays. | | concat | (...items: (T | ConcatArray<T>)[]) => T[] | Combines two or more arrays. This method returns a new array without modifying any existing arrays. | | join | (separator?: string | undefined) => string | Adds all the elements of an array into a string, separated by the specified separator string. | | reverse | () => T[] | Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array. | | shift | () => T | undefined | Removes the first element from an array and returns it. If the array is empty, undefined is returned and the array is not modified. | | slice | (start?: number | undefined, end?: number | undefined) => T[] | Returns a copy of a section of an array. For both start and end, a negative index can be used to indicate an offset from the end of the array. For example, -2 refers to the second to last element of the array. | | sort | (compareFn?: ((a: T, b: T) => number) | undefined) => this | Sorts an array in place. This method mutates the array and returns a reference to the same array. | | splice | (start: number, deleteCount?: number | undefined) => T[] | Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. | | splice | (start: number, deleteCount: number, ...items: T[]) => T[] | Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements. | | unshift | (...items: T[]) => number | Inserts new elements at the start of an array, and returns the new length of the array. | | indexOf | (searchElement: T, fromIndex?: number | undefined) => number | Returns the index of the first occurrence of a value in an array, or -1 if it is not present. | | lastIndexOf | (searchElement: T, fromIndex?: number | undefined) => number | Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present. | | every | <S extends T>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any) => this is S[] | Determines whether all the members of an array satisfy the specified test. | | every | (predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => boolean | Determines whether all the members of an array satisfy the specified test. | | some | (predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => boolean | Determines whether the specified callback function returns true for any element of an array. | | forEach | (callbackfn: (value: T, index: number, array: T[]) => void, thisArg?: any) => void | Performs the specified action for each element in an array. | | map | <U>(callbackfn: (value: T, index: number, array: T[]) => U, thisArg?: any) => U[] | Calls a defined callback function on each element of an array, and returns an array that contains the results. | | filter | <S extends T>(predicate: (value: T, index: number, array: T[]) => value is S, thisArg?: any) => S[] | Returns the elements of an array that meet the condition specified in a callback function. | | filter | (predicate: (value: T, index: number, array: T[]) => unknown, thisArg?: any) => T[] | Returns the elements of an array that meet the condition specified in a callback function. | | reduce | (callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T) => T | Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. | | reduce | (callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T) => T | | | reduce | <U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U) => U | Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. | | reduceRight | (callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T) => T | Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. | | reduceRight | (callbackfn: (previousValue: T, currentValue: T, currentIndex: number, array: T[]) => T, initialValue: T) => T | | | reduceRight | <U>(callbackfn: (previousValue: U, currentValue: T, currentIndex: number, array: T[]) => U, initialValue: U) => U | Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function. |

ConcatArray

| Prop | Type | | ------------ | ------------------- | | length | number |

| Method | Signature | | --------- | ------------------------------------------------------------------ | | join | (separator?: string | undefined) => string | | slice | (start?: number | undefined, end?: number | undefined) => T[] |

MoEGeneralAttributes

General Attributes for tracking events

| Prop | Type | | ----------- | ---------------------------------------------------------------- | | name | string | | value | string | number | boolean | string[] | number[] |

MoEDateTimeAttributes

Date and time attribute object

| Prop | Type | Description | | ----------- | ------------------- | ------------------------------------------------------------- | | name | string | Date and time attribute name | | value | string | Attribute value in ISO8601 format [yyyy-MM-dd'T'HH:mm:ss'Z']. |

MoELocationAttributes

Location attribute object

| Prop | Type | Description | | ----------- | --------------------------------------------------------- | ------------------------- | | name | string | Location Attribute name | | value | MoEGeoLocation | Location attribute value. |

MoEGeoLocation

Location object

| Prop | Type | | --------------- | ------------------- | | latitude | number | | longitude | number |

MoEInAppSelfHandledCampaignData

Data for self handled campaign.

| Prop | Type | Description | | ------------------ | ----------------------------------------------------------------------------------- | -------------------- | | accountMeta | MoEAccountMeta | Account information | | campaignData | MoEInAppCampaignData | In-App Campaign data | | selfHandled | MoEInAppSelfHandledCampaign | SelfHandled data |

MoEAccountMeta

Account Object

| Prop | Type | Description | | ----------- | ------------------- | ------------------ | | appId | string | Account identifier |

MoEInAppCampaignData

Campaign data.

| Prop | Type | Description | | --------------------- | --------------------------------------------------------------------------- | -------------------------------------------------------------------- | | campaignId | string | Unique Identifier for the campaign | | campaignName | string | Name given to the campaign while creation on the MoEngage Dashboard. | | campaignContext | MoEInAppCampaignContext | Additional Meta data related to the campaign. |

MoEInAppCampaignContext

Additional Meta data related to the campaign.

| Prop | Type | Description | | ------------------------- | --------------------------------------------------------- | --------------------------------------------- | | formattedCampaignId | string | Formatted Campaign Id | | attributes | Map<string, object> | Additional Meta data related to the campaign. |

Map

| Prop | Type | | ---------- | ------------------- | | size | number |

| Method | Signature | | ----------- | -------------------------------------------------------------------------------------------------------------- | | clear | () => void | | delete | (key: K) => boolean | | forEach | (callbackfn: (value: V, key: K, map: Map<K, V>) => void, thisArg?: any) => void | | get | (key: K) => V | undefined | | has | (key: K) => boolean | | set | (key: K, value: V) => this |

MoEInAppSelfHandledCampaign

Self Handled campaign object

| Prop | Type | Description | | --------------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | | payload | string | Self handled campaign payload. | | dismissInterval | number | Interval after which in-app should be dismissed, unit - Seconds | | isCancellable | boolean | Should the campaign be dismissed by pressing the back button or using the back gesture. if the value is true campaign should be dismissed on back press. |

PluginListenerHandle

| Prop | Type | | ------------ | ----------------------------------------- | | remove | () => Promise<void> |

MoEPushTokenData

Push token object

| Prop | Type | Description | | ----------------- | --------------------------------------------------------- | -------------------- | | platform | MoEPlatform | Platform type | | pushService | MoEPushService | Type of push service | | token | String | Push Token |

String

Allows manipulation and formatting of text strings and determination and location of substrings within strings.

| Prop | Type | Description | | ------------ | ------------------- | ------------------------------------------------------------ | | length | number | Returns the length of a String object. |

| Method | Signature | Description | | --------------------- | ------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------- | | toString | () => string | Returns a string representation of a string. | | charAt | (pos: number) => string | Returns the character at the specified index. | | charCodeAt | (index: number) => number | Returns the Unicode value of the character at the specified location. | | concat | (...strings: string[]) => string | Returns a string that contains the concatenation of two or more strings. | | indexOf | (searchString: string, position?: number | undefined) => number | Returns the position of the first occurrence of a substring. | | lastIndexOf | (searchString: string, position?: number | undefined) => number | Returns the last occurrence of a substring in the string. | | localeCompare | (that: string) => number | Determines whether two strings are equivalent in the current locale. | | match | (regexp: string | RegExp) => RegExpMatchArray | null | Matches a string with a regular expression, and returns an array containing the results of that search. | | replace | (searchValue: string | RegExp, replaceValue: string) => string | Replaces text in a string, using a regular expression or search string. | | replace | (searchValue: string | RegExp, replacer: (substring: string, ...args: any[]) => string) => string | Replaces text in a string, using a regular expression or search string. | | search | (regexp: string | RegExp) => number | Finds the first substring match in a regular expression search. | | slice | (start?: number | undefined, end?: number | undefined) => string | Returns a section of a string. | | split | (separator: string | RegExp, limit?: number | undefined) => string[] | Split a string into substrings using the specified separator and return them as an array. | | substring | (start: number, end?: number | undefined) => string | Returns the substring at the specified location within a String object. | | toLowerCase | () => string | Converts all the alphabetic characters in a string to lowercase. | | toLocaleLowerCase | (locales?: string | string[] | undefined) => string | Converts all alphabetic characters to lowercase, taking into account the host environment's current locale. | | toUpperCase | () => string | Converts all the alphabetic characters in a string to uppercase. | | toLocaleUpperCase | (locales?: string | string[] | undefined) => string | Returns a string where all alphabetic characters have been converted to uppercase, taking into account the host environment's current locale. | | trim | () => string | Removes the leading and trailing white space and line terminator characters from a string. | | substr | (from: number, length?: number | undefined) => string | Gets a substring beginning at the specified location and having the specified length. | | valueOf | () => string | Returns the primitive value of the specified object. |

RegExpMatchArray

| Prop | Type | | ----------- | ------------------- | | index | number | | input | string |

RegExp

| Prop | Type | Description | | ---------------- | -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | source | string | Returns a copy of the text of the regular expression pattern. Read-only. The regExp argument is a Regular expression object. It can be a variable name or a literal. | | global | boolean | Returns a Boolean value indicating the state of the global flag (g) used with a regular expression. Default is false. Read-only. | | ignoreCase | boolean | Returns a Boolean value indicating the state of the ignoreCase flag (i) used with a regular expression. Default is false. Read-only. | | multiline | boolean | Returns a Boolean value indicating the state of the multiline flag (m) used with a regular expression. Default is false. Read-only. | | lastIndex | number | |

| Method | Signature | Description | | ----------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | | exec | (string: string) => RegExpExecArray | null | Executes a search on a string using a regular expression pattern, and returns an array containing the results of that search. | | test | (string: string) => boolean | Returns a Boolean value that indicates whether or not a pattern exists in a searched string. | | compile | () => this | |

RegExpExecArray

| Prop | Type | | ----------- | ------------------- | | index | number | | input | string |

MoEPushCampaignData

Push event data

| Prop | Type | Description | | ------------------ | ----------------------------------------------------------- | -------------------- | | accountMeta | MoEAccountMeta | Account information | | pushCampaign | MoEPushCampaign | Push campaign object | | platform | MoEPlatform | Platform data |

MoEPushCampaign

Push campaign object

| Prop | Type | Description | | --------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | isDefaultAction | boolean | Is the click action a defualt action | | clickedAction | Map<String, object> | Clicked Action data | | payload | Map<String, object> | Key-Value Pair entered on the MoEngage Platform during campaign creation. |

MoEInAppLifecycleData

In-App lifecycle event camapaign data

| Prop | Type | Description | | ------------------ | --------------------------------------------------------------------- | -------------------- | | accountMeta | MoEAccountMeta | Account information | | campaignData | MoEInAppCampaignData | In-App Campaign data | | platform | MoEPlatform | Platform information |

MoEInAppNavigationData

In-App navigation event campaign data

| Prop | Type | Description | | ------------------ | --------------------------------------------------------------------- | ---------------------- | | accountMeta | MoEAccountMeta | Account information | | campaignData | MoEInAppCampaignData | In-App Campaign data | | navigation | MoEInAppNavigation | Navigation action data | | platform | MoEPlatform | Platform Data |

MoEInAppNavigation

In-App navigation action data

| Prop | Type | Description | | -------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | actionType | MoEInAppActionType | InApp Action type | | navigationType | string | Type of Navigation. | | navigationUrl | string | Navigation URL | | kvPair | Map<string, Object> | Key-Value Pair entered on the MoEngage Platform during campaign creation. |

Object

Provides functionality common to all JavaScript objects.

| Prop | Type | Description | | ----------------- | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | constructor | Function | The initial value of Object.prototype.constructor is the standard built-in Object constructor. |

| Method | Signature | Description | | ------------------------ | --------------------------------------------------------- | ------------------------------------------------------------------------ | |