# capacitor-moengage-core
MoEngage is a mobile marketing automation company. This capacitor SDK helps you track events, trigger smart notifications.
## Install
```bash
npm install capacitor-moengage-core
npx cap sync
```
## API
* [`initialize(...)`](#initialize)
* [`trackEvent(...)`](#trackevent)
* [`setUniqueId(...)`](#setuniqueid)
* [`setAlias(...)`](#setalias)
* [`setUserName(...)`](#setusername)
* [`setFirstName(...)`](#setfirstname)
* [`setLastName(...)`](#setlastname)
* [`setEmailId(...)`](#setemailid)
* [`setMobileNumber(...)`](#setmobilenumber)
* [`setBirthDate(...)`](#setbirthdate)
* [`setGender(...)`](#setgender)
* [`setUserLocation(...)`](#setuserlocation)
* [`setUserAttribute(...)`](#setuserattribute)
* [`setUserAttributeDate(...)`](#setuserattributedate)
* [`setUserAttributeLocation(...)`](#setuserattributelocation)
* [`setAppStatus(...)`](#setappstatus)
* [`logoutUser(...)`](#logoutuser)
* [`enableSdk(...)`](#enablesdk)
* [`disableSdk(...)`](#disablesdk)
* [`showInApp(...)`](#showinapp)
* [`getSelfHandledInApp(...)`](#getselfhandledinapp)
* [`selfHandledShown(...)`](#selfhandledshown)
* [`selfHandledClicked(...)`](#selfhandledclicked)
* [`selfHandledDismissed(...)`](#selfhandleddismissed)
* [`setInAppContext(...)`](#setinappcontext)
* [`resetInAppContext(...)`](#resetinappcontext)
* [`enableDataTracking(...)`](#enabledatatracking)
* [`disableDataTracking(...)`](#disabledatatracking)
* [`passFcmPushToken(...)`](#passfcmpushtoken)
* [`passFcmPushPayload(...)`](#passfcmpushpayload)
* [`registerForPush()`](#registerforpush)
* [`onOrientationChanged()`](#onorientationchanged)
* [`passAuthenticationDetails(...)`](#passauthenticationdetails)
* [`addListener('pushTokenGenerated', ...)`](#addlistenerpushtokengenerated-)
* [`addListener('pushClicked', ...)`](#addlistenerpushclicked-)
* [`addListener('inAppCampaignShown', ...)`](#addlistenerinappcampaignshown-)
* [`addListener('inAppCampaignClicked', ...)`](#addlistenerinappcampaignclicked-)
* [`addListener('inAppCampaignDismissed', ...)`](#addlistenerinappcampaigndismissed-)
* [`addListener('inAppCampaignCustomAction', ...)`](#addlistenerinappcampaigncustomaction-)
* [`addListener('inAppCampaignSelfHandled', ...)`](#addlistenerinappcampaignselfhandled-)
* [`addListener('logoutCompleted', ...)`](#addlistenerlogoutcompleted-)
* [`addListener('authenticationError', ...)`](#addlistenerauthenticationerror-)
* [`enableAdIdTracking(...)`](#enableadidtracking)
* [`disableAdIdTracking(...)`](#disableadidtracking)
* [`enableAndroidIdTracking(...)`](#enableandroididtracking)
* [`disableAndroidIdTracking(...)`](#disableandroididtracking)
* [`setupNotificationChannelsAndroid()`](#setupnotificationchannelsandroid)
* [`pushPermissionResponseAndroid(...)`](#pushpermissionresponseandroid)
* [`navigateToSettingsAndroid()`](#navigatetosettingsandroid)
* [`requestPushPermissionAndroid()`](#requestpushpermissionandroid)
* [`addListener('onPermissionResult', ...)`](#addlisteneronpermissionresult-)
* [`enableDeviceIdTracking(...)`](#enabledeviceidtracking)
* [`disableDeviceIdTracking(...)`](#disabledeviceidtracking)
* [`updatePushPermissionRequestCountAndroid(...)`](#updatepushpermissionrequestcountandroid)
* [`deleteUser(...)`](#deleteuser)
* [`showNudge(...)`](#shownudge)
* [`identifyUser(...)`](#identifyuser)
* [`getUserIdentities(...)`](#getuseridentities)
* [`getSelfHandledInApps(...)`](#getselfhandledinapps)
* [`registerForProvisionalPush()`](#registerforprovisionalpush)
* [Interfaces](#interfaces)
* [Type Aliases](#type-aliases)
* [Enums](#enums)
### initialize(...)
```typescript
initialize(options: { appId: string; initConfig: MoEInitConfig; lifecycleAwareCallbackEnabled?: boolean; }) => Promise
```
Initialise MoEngage Capacitor Plugin
| Param | Type |
| ------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| **`options`** | { appId: string; initConfig: MoEInitConfig; lifecycleAwareCallbackEnabled?: boolean; } |
**Since:** 2.0.0
--------------------
### trackEvent(...)
```typescript
trackEvent(options: { eventName: string; eventAttributes?: MoEProperties; appId: string; }) => Promise
```
Track user behaviour as events with properties
| Param | Type |
| ------------- | ---------------------------------------------------------------------------------------------------------------- |
| **`options`** | { eventName: string; eventAttributes?: MoEProperties; appId: string; } |
**Since:** 2.0.0
--------------------
### setUniqueId(...)
```typescript
setUniqueId(options: { uniqueId: string; appId: string; }) => Promise
```
Set a Unique Identifier for the user.
| Param | Type |
| ------------- | ------------------------------------------------- |
| **`options`** | { uniqueId: string; appId: string; } |
**Since:** 2.0.0
--------------------
### setAlias(...)
```typescript
setAlias(options: { alias: string; appId: string; }) => Promise
```
Set an Alias to update the existing Unique Id
| Param | Type |
| ------------- | ---------------------------------------------- |
| **`options`** | { alias: string; appId: string; } |
**Since:** 2.0.0
--------------------
### setUserName(...)
```typescript
setUserName(options: { userName: string; appId: string; }) => Promise
```
Set user's full name
| Param | Type |
| ------------- | ------------------------------------------------- |
| **`options`** | { userName: string; appId: string; } |
**Since:** 2.0.0
--------------------
### setFirstName(...)
```typescript
setFirstName(options: { firstName: string; appId: string; }) => Promise
```
Set user's first name
| Param | Type |
| ------------- | -------------------------------------------------- |
| **`options`** | { firstName: string; appId: string; } |
**Since:** 2.0.0
--------------------
### setLastName(...)
```typescript
setLastName(options: { lastName: string; appId: string; }) => Promise
```
Set user's last name
| Param | Type |
| ------------- | ------------------------------------------------- |
| **`options`** | { lastName: string; appId: string; } |
--------------------
### setEmailId(...)
```typescript
setEmailId(options: { emailId: string; appId: string; }) => Promise
```
Set user's email id
| Param | Type |
| ------------- | ------------------------------------------------ |
| **`options`** | { emailId: string; appId: string; } |
**Since:** 2.0.0
--------------------
### setMobileNumber(...)
```typescript
setMobileNumber(options: { mobileNumber: string; appId: string; }) => Promise
```
Set user's mobile number
| Param | Type |
| ------------- | ----------------------------------------------------- |
| **`options`** | { mobileNumber: string; appId: string; } |
--------------------
### setBirthDate(...)
```typescript
setBirthDate(options: { birthdate: string; appId: string; }) => Promise
```
Set user's birthdate.
| Param | Type |
| ------------- | -------------------------------------------------- |
| **`options`** | { birthdate: string; appId: string; } |
**Since:** 1.0.0
--------------------
### setGender(...)
```typescript
setGender(options: { gender: MoEUserGender; appId: string; }) => Promise
```
Set user's gender.
| Param | Type |
| ------------- | ----------------------------------------------------------------------------------- |
| **`options`** | { gender: MoEUserGender; appId: string; } |
**Since:** 2.0.0
--------------------
### setUserLocation(...)
```typescript
setUserLocation(options: { location: MoEGeoLocation; appId: string; }) => Promise
```
Set user's location
| Param | Type |
| ------------- | --------------------------------------------------------------------------------------- |
| **`options`** | { location: MoEGeoLocation; appId: string; } |
**Since:** 2.0.0
--------------------
### setUserAttribute(...)
```typescript
setUserAttribute(options: { name: string; value: string | number | boolean | Array | Array; appId: string; }) => Promise
```
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(...)
```typescript
setUserAttributeDate(options: { name: string; value: string; appId: string; }) => Promise
```
Set a user attribute timestamp for the current user
| Param | Type |
| ------------- | ------------------------------------------------------------ |
| **`options`** | { name: string; value: string; appId: string; } |
**Since:** 2.0.0
--------------------
### setUserAttributeLocation(...)
```typescript
setUserAttributeLocation(options: { name: string; location: MoEGeoLocation; appId: string; }) => Promise
```
Set the user attribute location
| Param | Type |
| ------------- | ----------------------------------------------------------------------------------------------------- |
| **`options`** | { name: string; location: MoEGeoLocation; appId: string; } |
**Since:** 2.0.0
--------------------
### setAppStatus(...)
```typescript
setAppStatus(options: { appStatus: MoEAppStatus; appId: string; }) => Promise
```
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(...)
```typescript
logoutUser(options: { appId: string; }) => Promise
```
Notify the SDK that the user has logged out of the application
| Param | Type |
| ------------- | ------------------------------- |
| **`options`** | { appId: string; } |
**Since:** 2.0.0
--------------------
### enableSdk(...)
```typescript
enableSdk(options: { appId: string; }) => Promise
```
API to enable SDK usage.
| Param | Type |
| ------------- | ------------------------------- |
| **`options`** | { appId: string; } |
**Since:** 2.0.0
--------------------
### disableSdk(...)
```typescript
disableSdk(options: { appId: string; }) => Promise
```
API to disable all features of the SDK.
| Param | Type |
| ------------- | ------------------------------- |
| **`options`** | { appId: string; } |
**Since:** 2.0.0
--------------------
### showInApp(...)
```typescript
showInApp(options: { appId: string; }) => Promise
```
Call this method wherever InApp message has to be shown, if available.
| Param | Type |
| ------------- | ------------------------------- |
| **`options`** | { appId: string; } |
**Since:** 2.0.0
--------------------
### getSelfHandledInApp(...)
```typescript
getSelfHandledInApp(options: { appId: string; }) => Promise
```
Triggers fetching self handled in-app, the result is returned in the `inAppCampaignSelfHandled` listener
| Param | Type |
| ------------- | ------------------------------- |
| **`options`** | { appId: string; } |
**Since:** 2.0.0
--------------------
### selfHandledShown(...)
```typescript
selfHandledShown(campaignData: MoEInAppSelfHandledCampaignData) => Promise
```
API to track self handled in-app shown event.
| Param | Type | Description |
| ------------------ | ------------------------------------------------------------------------------------------- | --------------- |
| **`campaignData`** | MoEInAppSelfHandledCampaignData | in-app campaign |
**Since:** 2.0.0
--------------------
### selfHandledClicked(...)
```typescript
selfHandledClicked(campaignData: MoEInAppSelfHandledCampaignData) => Promise
```
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(...)
```typescript
selfHandledDismissed(campaignData: MoEInAppSelfHandledCampaignData) => Promise
```
API to track self handled in-app's dismiss event.
| Param | Type | Description |
| ------------------ | ------------------------------------------------------------------------------------------- | --------------- |
| **`campaignData`** | MoEInAppSelfHandledCampaignData | in-app campaign |
**Since:** 2.0.0
--------------------
### setInAppContext(...)
```typescript
setInAppContext(options: { contexts: Array; appId: string; }) => Promise
```
Set current context for in-app module.
| Param | Type |
| ------------- | --------------------------------------------------- |
| **`options`** | { contexts: string[]; appId: string; } |
**Since:** 2.0.0
--------------------
### resetInAppContext(...)
```typescript
resetInAppContext(options: { appId: string; }) => Promise
```
Resets/Clears the previously set context for in-app module.
| Param | Type |
| ------------- | ------------------------------- |
| **`options`** | { appId: string; } |
**Since:** 2.0.0
--------------------
### enableDataTracking(...)
```typescript
enableDataTracking(options: { appId: string; }) => Promise
```
Optionally opt-in data tracking.
| Param | Type |
| ------------- | ------------------------------- |
| **`options`** | { appId: string; } |
**Since:** 2.0.0
--------------------
### disableDataTracking(...)
```typescript
disableDataTracking(options: { appId: string; }) => Promise
```
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(...)
```typescript
passFcmPushToken(options: { token: string; appId: string; }) => Promise
```
Pass FCM Push Token to the MoEngage SDK
| Param | Type |
| ------------- | ---------------------------------------------- |
| **`options`** | { token: string; appId: string; } |
**Since:** 2.0.0
--------------------
### passFcmPushPayload(...)
```typescript
passFcmPushPayload(options: { payload: object; appId: string; }) => Promise
```
Pass FCM payload to MoEngage SDK
| Param | Type |
| ------------- | ------------------------------------------------ |
| **`options`** | { payload: object; appId: string; } |
**Since:** 2.0.0
--------------------
### registerForPush()
```typescript
registerForPush() => Promise
```
Register For Push Notification for iOS
**Since:** 2.0.0
--------------------
### onOrientationChanged()
```typescript
onOrientationChanged() => Promise
```
Notifies MoEngage SDK of device orientation change
**Since:** 2.0.0
--------------------
### passAuthenticationDetails(...)
```typescript
passAuthenticationDetails(options: { authenticationData: MoEAuthenticationData; appId: string; }) => Promise
```
Pass JWT authentication details to the native SDK (after login / token refresh).
| Param | Type |
| ------------- | --------------------------------------------------------------------------------------------------------------- |
| **`options`** | { authenticationData: MoEAuthenticationData; appId: string; } |
**Since:** 7.1.0
--------------------
### addListener('pushTokenGenerated', ...)
```typescript
addListener(eventName: 'pushTokenGenerated', listenerFunc: MoEPushTokenListener) => Promise & PluginListenerHandle
```
Listen for push token generated event
| Param | Type |
| ------------------ | --------------------------------------------------------------------- |
| **`eventName`** | 'pushTokenGenerated' |
| **`listenerFunc`** | MoEPushTokenListener |
**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle
**Since:** 2.0.0
--------------------
### addListener('pushClicked', ...)
```typescript
addListener(eventName: 'pushClicked', listenerFunc: MoEPushClickListener) => Promise & PluginListenerHandle
```
Listen for push clicked event
| Param | Type |
| ------------------ | --------------------------------------------------------------------- |
| **`eventName`** | 'pushClicked' |
| **`listenerFunc`** | MoEPushClickListener |
**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle
**Since:** 1.0.0
--------------------
### addListener('inAppCampaignShown', ...)
```typescript
addListener(eventName: 'inAppCampaignShown', listenerFunc: MoEInAppShownListener) => Promise & PluginListenerHandle
```
Listen for in-app campaign shown event
| Param | Type |
| ------------------ | ----------------------------------------------------------------------- |
| **`eventName`** | 'inAppCampaignShown' |
| **`listenerFunc`** | MoEInAppShownListener |
**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle
**Since:** 1.0.0
--------------------
### addListener('inAppCampaignClicked', ...)
```typescript
addListener(eventName: 'inAppCampaignClicked', listenerFunc: MoEInAppClickedListener) => Promise & PluginListenerHandle
```
Listen for in-app campaign clicked event
| Param | Type |
| ------------------ | --------------------------------------------------------------------------- |
| **`eventName`** | 'inAppCampaignClicked' |
| **`listenerFunc`** | MoEInAppClickedListener |
**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle
**Since:** 1.0.0
--------------------
### addListener('inAppCampaignDismissed', ...)
```typescript
addListener(eventName: 'inAppCampaignDismissed', listenerFunc: MoEInAppDismissedListener) => Promise & PluginListenerHandle
```
| Param | Type |
| ------------------ | ------------------------------------------------------------------------------- |
| **`eventName`** | 'inAppCampaignDismissed' |
| **`listenerFunc`** | MoEInAppDismissedListener |
**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle
--------------------
### addListener('inAppCampaignCustomAction', ...)
```typescript
addListener(eventName: 'inAppCampaignCustomAction', listenerFunc: MoEInAppCustomActionListener) => Promise & 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', ...)
```typescript
addListener(eventName: 'inAppCampaignSelfHandled', listenerFunc: MoEInAppSelfHandledListener) => Promise & 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
--------------------
### addListener('logoutCompleted', ...)
```typescript
addListener(eventName: 'logoutCompleted', listenerFunc: MoELogoutCompleteListener) => Promise & PluginListenerHandle
```
Listen for logout complete event
| Param | Type |
| ------------------ | ------------------------------------------------------------------------------- |
| **`eventName`** | 'logoutCompleted' |
| **`listenerFunc`** | MoELogoutCompleteListener |
**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle
**Since:** 7.0.0
--------------------
### addListener('authenticationError', ...)
```typescript
addListener(eventName: 'authenticationError', listenerFunc: MoEAuthenticationErrorListener) => Promise & PluginListenerHandle
```
Listen for authentication errors from the MoEngage SDK (e.g. JWT validation failures).
| Param | Type |
| ------------------ | ----------------------------------------------------------------------------------------- |
| **`eventName`** | 'authenticationError' |
| **`listenerFunc`** | MoEAuthenticationErrorListener |
**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle
**Since:** 7.1.0
--------------------
### enableAdIdTracking(...)
```typescript
enableAdIdTracking(options: { appId: string; }) => Promise
```
Enables GAID tracking, by default GAID tracking is disabled.
| Param | Type |
| ------------- | ------------------------------- |
| **`options`** | { appId: string; } |
**Since:** 2.0.0
--------------------
### disableAdIdTracking(...)
```typescript
disableAdIdTracking(options: { appId: string; }) => Promise
```
Disables GAID tracking.
| Param | Type |
| ------------- | ------------------------------- |
| **`options`** | { appId: string; } |
**Since:** 2.0.0
--------------------
### enableAndroidIdTracking(...)
```typescript
enableAndroidIdTracking(options: { appId: string; }) => Promise
```
Enables Android ID tracking, by default ANdroid ID tracking is disabled.
| Param | Type |
| ------------- | ------------------------------- |
| **`options`** | { appId: string; } |
**Since:** 2.0.0
--------------------
### disableAndroidIdTracking(...)
```typescript
disableAndroidIdTracking(options: { appId: string; }) => Promise
```
Disables Android ID tracking.
| Param | Type |
| ------------- | ------------------------------- |
| **`options`** | { appId: string; } |
**Since:** 2.0.0
--------------------
### setupNotificationChannelsAndroid()
```typescript
setupNotificationChannelsAndroid() => Promise
```
API to create notification channels on Android.
**Since:** 2.0.0
--------------------
### pushPermissionResponseAndroid(...)
```typescript
pushPermissionResponseAndroid(options: { isGranted: boolean; }) => Promise
```
Notify the SDK on notification permission granted to the application.
| Param | Type |
| ------------- | ------------------------------------ |
| **`options`** | { isGranted: boolean; } |
**Since:** 2.0.0
--------------------
### navigateToSettingsAndroid()
```typescript
navigateToSettingsAndroid() => Promise
```
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()
```typescript
requestPushPermissionAndroid() => Promise
```
Requests the push permission on Android 13 and above.
--------------------
### addListener('onPermissionResult', ...)
```typescript
addListener(eventName: 'onPermissionResult', listenerFunc: MoEPermissionListener) => Promise & PluginListenerHandle
```
Listen for permission response
| Param | Type |
| ------------------ | ----------------------------------------------------------------------- |
| **`eventName`** | 'onPermissionResult' |
| **`listenerFunc`** | MoEPermissionListener |
**Returns:** Promise<PluginListenerHandle> & PluginListenerHandle
**Since:** 2.0.0
--------------------
### enableDeviceIdTracking(...)
```typescript
enableDeviceIdTracking(options: { appId: string; }) => Promise
```
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(...)
```typescript
disableDeviceIdTracking(options: { appId: string; }) => Promise
```
Disables Device-id tracking.
| Param | Type |
| ------------- | ------------------------------- |
| **`options`** | { appId: string; } |
--------------------
### updatePushPermissionRequestCountAndroid(...)
```typescript
updatePushPermissionRequestCountAndroid(options: { appId: string; count: number; }) => Promise
```
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(...)
```typescript
deleteUser(options: { appId: string; }, callback: MoEUserDeleteCallback) => Promise
```
Delete Current User Data From MoEngage Server
| Param | Type | Description |
| -------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| **`options`** | { appId: string; } | |
| **`callback`** | MoEUserDeleteCallback | instance of {@link MoEUserDeleteCallback} to get the API response |
--------------------
### showNudge(...)
```typescript
showNudge(options: { position: MoENudgePosition; appId: string; }) => Promise
```
Show Nudge
| Param | Type |
| ------------- | ------------------------------------------------------------------------------------------- |
| **`options`** | { position: MoENudgePosition; appId: string; } |
--------------------
### identifyUser(...)
```typescript
identifyUser(options: { identity: string | { [key: string]: string; }; appId: string; }) => Promise
```
Identify User
| Param | Type |
| ------------- | ------------------------------------------------------------------------------- |
| **`options`** | { identity: string \| { [key: string]: string; }; appId: string; } |
**Since:** 7.0.0
--------------------
### getUserIdentities(...)
```typescript
getUserIdentities(options: { appId: string; }) => Promise | null>
```
Get User Identities
| Param | Type |
| ------------- | ------------------------------- |
| **`options`** | { appId: string; } |
**Returns:** Promise<Map<String, String> | null>
**Since:** 7.0.0
--------------------
### getSelfHandledInApps(...)
```typescript
getSelfHandledInApps(options: { appId: string; }) => Promise
```
Get Multiple self handled in-app campaigns
| Param | Type |
| ------------- | ------------------------------- |
| **`options`** | { appId: string; } |
**Returns:** Promise<MoEInAppSelfHandledCampaignsData>
**Since:** 7.0.0
--------------------
### registerForProvisionalPush()
```typescript
registerForProvisionalPush() => Promise
```
Register For Provisional Push Notifications for iOS
**Since:** 7.0.0
--------------------
### Interfaces
#### MoEInitConfig
| Prop | Type | Description |
| --------------------- | ----------------------------------------------------------------- | --------------------- |
| **`analyticsConfig`** | MoEAnalyticsConfig | Analytics Config data |
| **`pushConfig`** | MoEPushConfig | Push Config data |
#### MoEAnalyticsConfig
| Prop | Type | Description |
| --------------------------------------------- | -------------------- | ---------------------------------------------------------------------------- |
| **`shouldTrackUserAttributeBooleanAsNumber`** | boolean | Status of whether boolean user attribute should be tracked as number or not. |
#### MoEPushConfig
| Prop | Type | Description |
| -------------------------------------------- | -------------------- | --------------------------------------------------------------------------- |
| **`shouldDeliverCallbackOnForegroundClick`** | boolean | Whether to deliver callback when push notification is clicked in foreground |
#### 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 |
| **`platform`** | MoEPlatform | Platform information |
#### 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 |
| **`displayRules`** | MoEInAppDisplayRules | Display rules for the campaign |
#### MoEInAppDisplayRules
Display rules for self handled campaign
| Prop | Type | Description |
| ----------------- | ----------------------------------------------------- | ---------------------------------------------- |
| **`screenName`** | string | Screen name where campaign should be displayed |
| **`contexts`** | Array<string> | List of contexts |
| **`screenNames`** | Array<string> | List of screen names |
#### MoEAuthenticationData
Authentication details payload.
| Prop | Type |
| ------------------------ | ----------------------------------------------------------------------------- |
| **`authenticationType`** | MoEAuthenticationType |
| **`data`** | MoEAuthenticationDetails |
#### MoEAuthenticationDetails
Base interface for authentication data.
#### 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 |
| ------------------------ | --------------------------------------------------------- | ------------------------------------------------------------------------ |
| **toString** | () => string | Returns a string representation of an object. |
| **toLocaleString** | () => string | Returns a date converted to a string using the current locale. |
| **valueOf** | () => Object | Returns the primitive value of the specified object. |
| **hasOwnProperty** | (v: PropertyKey) => boolean | Determines whether an object has a property with the specified name. |
| **isPrototypeOf** | (v: Object) => boolean | Determines whether an object exists in another object's prototype chain. |
| **propertyIsEnumerable** | (v: PropertyKey) => boolean | Determines whether a specified property is enumerable. |
#### Function
Creates a new function.
| Prop | Type |
| --------------- | --------------------------------------------- |
| **`prototype`** | any |
| **`length`** | number |
| **`arguments`** | any |
| **`caller`** | Function |
| Method | Signature | Description |
| ------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| **apply** | (this: Function, thisArg: any, argArray?: any) => any | Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function. |
| **call** | (this: Function, thisArg: any, ...argArray: any[]) => any | Calls a method of an object, substituting another object for the current object. |
| **bind** | (this: Function, thisArg: any, ...argArray: any[]) => any | For a given function, creates a bound function that has the same body as the original function. The this object of the bound function is associated with the specified object, and has the specified initial parameters. |
| **toString** | () => string | Returns a string representation of a function. |
#### MoEInAppCustomActionData
In-App custom event campaign data
| Prop | Type | Description |
| ------------------ | --------------------------------------------------------------------- | -------------------- |
| **`accountMeta`** | MoEAccountMeta | Account information |
| **`campaignData`** | MoEInAppCampaignData | In-App Campaign data |
| **`customAction`** | MoEInAppCustomAction | Custom Action data |
| **`platform`** | MoEPlatform | Platform information |
#### MoEInAppCustomAction
In-App custom action data
| Prop | Type | Description |
| ---------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------- |
| **`actionType`** | MoEInAppActionType | InApp Action type |
| **`kvPair`** | Map<string, object> | Key-Value Pair entered on the MoEngage Platform during campaign creation. |
#### MoELogoutCompleteData
Data returned when a logout operation is successfully completed.
| Prop | Type | Description |
| ----------------- | --------------------------------------------------------- | ------------------- |
| **`accountMeta`** | MoEAccountMeta | Account information |
| **`platform`** | MoEPlatform | Platform type |
#### MoEAuthenticationErrorData
Authentication error data.
| Prop | Type |
| ------------------------ | --------------------------------------------------------------------------------------- |
| **`accountMeta`** | MoEAccountMeta |
| **`platform`** | MoEPlatform |
| **`authenticationType`** | MoEAuthenticationType |
| **`data`** | MoEAuthenticationErrorDetails |
#### MoEAuthenticationErrorDetails
Base interface for error data.
#### MoEPermissionResultData
Permission Response Data
| Prop | Type | Description |
| --------------- | --------------------------------------------------------------- | ------------------- |
| **`platform`** | MoEPlatform | Platform type |
| **`isGranted`** | boolean | State of permission |
| **`type`** | MoEPermissionType | Type of permission |
#### MoEUserDeleteData
User Delete Response Data
| Prop | Type | Description |
| ----------------- | --------------------------------------------------------- | ----------------------- |
| **`accountMeta`** | MoEAccountMeta | Account information |
| **`isSuccess`** | boolean | Status of user deletion |
#### MoEInAppSelfHandledCampaignsData
Data for multiple self handled campaigns.
| Prop | Type | Description |
| ----------------- | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------- |
| **`accountMeta`** | MoEAccountMeta | Account information |
| **`campaigns`** | Array<MoEInAppSelfHandledCampaignData> | Array of self handled campaigns |
### Type Aliases
#### MoEPushTokenListener
(event: MoEPushTokenData): void
#### MoEPushClickListener
(event: MoEPushCampaignData): void
#### MoEInAppShownListener
(event: MoEInAppLifecycleData): void
#### MoEInAppClickedListener
(event: MoEInAppNavigationData): void
#### PropertyKey
string | number | symbol
#### MoEInAppDismissedListener
(event: MoEInAppLifecycleData): void
#### MoEInAppCustomActionListener
(event: MoEInAppCustomActionData): void
#### MoEInAppSelfHandledListener
(event: MoEInAppSelfHandledCampaignData): void
#### MoELogoutCompleteListener
(event: MoELogoutCompleteData): void
#### MoEAuthenticationErrorListener
(event: MoEAuthenticationErrorData): void
#### MoEPermissionListener
(event: MoEPermissionResultData): void
#### MoEUserDeleteCallback
(userDeleteData: MoEUserDeleteData): void
### Enums
#### MoEUserGender
| Members | Value |
| ------------ | --------------------- |
| **`MALE`** | "male" |
| **`FEMALE`** | "female" |
| **`OTHER`** | "other" |
#### MoEAppStatus
| Members | Value | Description |
| ------------- | ---------------------- | ----------------------------------------------------- |
| **`INSTALL`** | "install" | Fresh installation of the app instance. |
| **`UPDATE`** | "update" | App was already present and user has updated the app. |
#### MoEPlatform
| Members | Value |
| ------------- | ---------------------- |
| **`iOS`** | "iOS" |
| **`ANDROID`** | "android" |
#### MoEAuthenticationType
| Members | Value |
| --------- | ------------------ |
| **`JWT`** | 'JWT' |
#### MoEPushService
| Members |
| -------------- |
| **`APNS`** |
| **`FCM`** |
| **`MI_PUSH`** |
| **`PUSH_KIT`** |
#### MoEInAppActionType
| Members | Value |
| ---------------- | ------------------------- |
| **`NAVIGATION`** | "navigation" |
| **`CUSTOM`** | "custom" |
#### MoEPermissionType
| Members | Value |
| ---------- | ------------------- |
| **`PUSH`** | "push" |
#### MoENudgePosition
| Members | Value |
| ----------------- | -------------------------- |
| **`Top`** | "top" |
| **`Bottom`** | "bottom" |
| **`BottomLeft`** | "bottomLeft" |
| **`BottomRight`** | "bottomRight" |
| **`Any`** | "any" |