capacitor-moengage-core/dist/docs.json

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

{
  "api": {
    "name": "MoECapacitorCorePlugin",
    "slug": "moecapacitorcoreplugin",
    "docs": "",
    "tags": [],
    "methods": [
      {
        "name": "initialize",
        "signature": "(options: { appId: string; initConfig: MoEInitConfig; lifecycleAwareCallbackEnabled?: boolean; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appId: string; initConfig: MoEInitConfig; lifecycleAwareCallbackEnabled?: boolean | undefined; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "param",
            "text": "initConfig SDK initialization configuration"
          },
          {
            "name": "param",
            "text": "lifecycleAwareCallbackEnabled Enable lifecycle-aware callback handling.\nWhen enabled, events are queued when app goes to background\nand flushed when app returns to foreground, default as false."
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Initialise MoEngage Capacitor Plugin",
        "complexTypes": [
          "MoEInitConfig"
        ],
        "slug": "initialize"
      },
      {
        "name": "trackEvent",
        "signature": "(options: { eventName: string; eventAttributes?: MoEProperties; appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ eventName: string; eventAttributes?: MoEProperties | undefined; appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "eventName Event Name"
          },
          {
            "name": "param",
            "text": "properties \\} properties of the event."
          },
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Track user behaviour as events with properties",
        "complexTypes": [
          "MoEProperties"
        ],
        "slug": "trackevent"
      },
      {
        "name": "setUniqueId",
        "signature": "(options: { uniqueId: string; appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ uniqueId: string; appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "uniqueId identifier"
          },
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Set a Unique Identifier for the user.",
        "complexTypes": [],
        "slug": "setuniqueid"
      },
      {
        "name": "setAlias",
        "signature": "(options: { alias: string; appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ alias: string; appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "alias identifier"
          },
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Set an Alias to update the existing Unique Id",
        "complexTypes": [],
        "slug": "setalias"
      },
      {
        "name": "setUserName",
        "signature": "(options: { userName: string; appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ userName: string; appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "userName full name of the user"
          },
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Set user's full name",
        "complexTypes": [],
        "slug": "setusername"
      },
      {
        "name": "setFirstName",
        "signature": "(options: { firstName: string; appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ firstName: string; appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "firstName first name of the user"
          },
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Set user's first name",
        "complexTypes": [],
        "slug": "setfirstname"
      },
      {
        "name": "setLastName",
        "signature": "(options: { lastName: string; appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ lastName: string; appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "lastName last name of the user"
          },
          {
            "name": "param",
            "text": "appId Account Identifier"
          }
        ],
        "docs": "Set user's last name",
        "complexTypes": [],
        "slug": "setlastname"
      },
      {
        "name": "setEmailId",
        "signature": "(options: { emailId: string; appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ emailId: string; appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "emailId email id"
          },
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Set user's email id",
        "complexTypes": [],
        "slug": "setemailid"
      },
      {
        "name": "setMobileNumber",
        "signature": "(options: { mobileNumber: string; appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ mobileNumber: string; appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "mobileNumber mobile number"
          },
          {
            "name": "param",
            "text": "appId Account Identifier"
          }
        ],
        "docs": "Set user's mobile number",
        "complexTypes": [],
        "slug": "setmobilenumber"
      },
      {
        "name": "setBirthDate",
        "signature": "(options: { birthdate: string; appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ birthdate: string; appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "birthdate birthdate to be set in ISO8601 format [yyyy-MM-dd'T'HH:mm:ss'Z']."
          },
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "1.0.0"
          }
        ],
        "docs": "Set user's birthdate.",
        "complexTypes": [],
        "slug": "setbirthdate"
      },
      {
        "name": "setGender",
        "signature": "(options: { gender: MoEUserGender; appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ gender: MoEUserGender; appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "gender value"
          },
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Set user's gender.",
        "complexTypes": [
          "MoEUserGender"
        ],
        "slug": "setgender"
      },
      {
        "name": "setUserLocation",
        "signature": "(options: { location: MoEGeoLocation; appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ location: MoEGeoLocation; appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "location of the user"
          },
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Set user's location",
        "complexTypes": [
          "MoEGeoLocation"
        ],
        "slug": "setuserlocation"
      },
      {
        "name": "setUserAttribute",
        "signature": "(options: { name: string; value: string | number | boolean | Array<string> | Array<number>; appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ name: string; value: string | number | boolean | string[] | number[]; appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "name user attribute name"
          },
          {
            "name": "param",
            "text": "value user attribute value"
          },
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Set the user defined attribute with value.",
        "complexTypes": [
          "Array"
        ],
        "slug": "setuserattribute"
      },
      {
        "name": "setUserAttributeDate",
        "signature": "(options: { name: string; value: string; appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ name: string; value: string; appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "name attribute name"
          },
          {
            "name": "param",
            "text": "value User attribute value in ISO8601 format [yyyy-MM-dd'T'HH:mm:ss'Z']."
          },
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Set a user attribute timestamp for the current user",
        "complexTypes": [],
        "slug": "setuserattributedate"
      },
      {
        "name": "setUserAttributeLocation",
        "signature": "(options: { name: string; location: MoEGeoLocation; appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ name: string; location: MoEGeoLocation; appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "name attribute name"
          },
          {
            "name": "param",
            "text": "location"
          },
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Set the user attribute location",
        "complexTypes": [
          "MoEGeoLocation"
        ],
        "slug": "setuserattributelocation"
      },
      {
        "name": "setAppStatus",
        "signature": "(options: { appStatus: MoEAppStatus; appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appStatus: MoEAppStatus; appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "appStatus if it is an existing user set \"update\" else set \"install\""
          },
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "This API tells the SDK whether it is a fresh install or an existing application was updated.",
        "complexTypes": [
          "MoEAppStatus"
        ],
        "slug": "setappstatus"
      },
      {
        "name": "logoutUser",
        "signature": "(options: { appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Notify the SDK that the user has logged out of the application",
        "complexTypes": [],
        "slug": "logoutuser"
      },
      {
        "name": "enableSdk",
        "signature": "(options: { appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "remarks",
            "text": "By default the SDK is enabled, this API should only be called if you have called\n`disableSdk()` at some point."
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "API to enable SDK usage.",
        "complexTypes": [],
        "slug": "enablesdk"
      },
      {
        "name": "disableSdk",
        "signature": "(options: { appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "API to disable all features of the SDK.",
        "complexTypes": [],
        "slug": "disablesdk"
      },
      {
        "name": "showInApp",
        "signature": "(options: { appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Call this method wherever InApp message has to be shown, if available.",
        "complexTypes": [],
        "slug": "showinapp"
      },
      {
        "name": "getSelfHandledInApp",
        "signature": "(options: { appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Triggers fetching self handled in-app, the result is returned in the `inAppCampaignSelfHandled` listener",
        "complexTypes": [],
        "slug": "getselfhandledinapp"
      },
      {
        "name": "selfHandledShown",
        "signature": "(campaignData: MoEInAppSelfHandledCampaignData) => Promise<void>",
        "parameters": [
          {
            "name": "campaignData",
            "docs": "in-app campaign",
            "type": "MoEInAppSelfHandledCampaignData"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "campaignData in-app campaign"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "API to track self handled in-app shown event.",
        "complexTypes": [
          "MoEInAppSelfHandledCampaignData"
        ],
        "slug": "selfhandledshown"
      },
      {
        "name": "selfHandledClicked",
        "signature": "(campaignData: MoEInAppSelfHandledCampaignData) => Promise<void>",
        "parameters": [
          {
            "name": "campaignData",
            "docs": "in-app campaign",
            "type": "MoEInAppSelfHandledCampaignData"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "campaignData in-app campaign"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "API to track click event of any other widget apart from primary widget in the self handled in-app.",
        "complexTypes": [
          "MoEInAppSelfHandledCampaignData"
        ],
        "slug": "selfhandledclicked"
      },
      {
        "name": "selfHandledDismissed",
        "signature": "(campaignData: MoEInAppSelfHandledCampaignData) => Promise<void>",
        "parameters": [
          {
            "name": "campaignData",
            "docs": "in-app campaign",
            "type": "MoEInAppSelfHandledCampaignData"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "campaignData in-app campaign"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "API to track self handled in-app's dismiss event.",
        "complexTypes": [
          "MoEInAppSelfHandledCampaignData"
        ],
        "slug": "selfhandleddismissed"
      },
      {
        "name": "setInAppContext",
        "signature": "(options: { contexts: Array<string>; appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ contexts: string[]; appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "contexts array of contexts"
          },
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Set current context for in-app module.",
        "complexTypes": [
          "Array"
        ],
        "slug": "setinappcontext"
      },
      {
        "name": "resetInAppContext",
        "signature": "(options: { appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Resets/Clears the previously set context for in-app module.",
        "complexTypes": [],
        "slug": "resetinappcontext"
      },
      {
        "name": "enableDataTracking",
        "signature": "(options: { appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Optionally opt-in data tracking.",
        "complexTypes": [],
        "slug": "enabledatatracking"
      },
      {
        "name": "disableDataTracking",
        "signature": "(options: { appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Optionally opt-out of data tracking. When data tracking is opted no event or user\nattribute is tracked on MoEngage Platform.",
        "complexTypes": [],
        "slug": "disabledatatracking"
      },
      {
        "name": "passFcmPushToken",
        "signature": "(options: { token: string; appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ token: string; appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "remarks",
            "text": "This API is only for `Android`"
          },
          {
            "name": "param",
            "text": "token FCM token"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Pass FCM Push Token to the MoEngage SDK",
        "complexTypes": [],
        "slug": "passfcmpushtoken"
      },
      {
        "name": "passFcmPushPayload",
        "signature": "(options: { payload: object; appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ payload: object; appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "remarks",
            "text": "This API is only for `Android`"
          },
          {
            "name": "param",
            "text": "payload Push payload"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Pass FCM payload to MoEngage SDK",
        "complexTypes": [],
        "slug": "passfcmpushpayload"
      },
      {
        "name": "registerForPush",
        "signature": "() => Promise<void>",
        "parameters": [],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "remarks",
            "text": "This API is only for `iOS`"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Register For Push Notification for iOS",
        "complexTypes": [],
        "slug": "registerforpush"
      },
      {
        "name": "onOrientationChanged",
        "signature": "() => Promise<void>",
        "parameters": [],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "remarks",
            "text": "This API is only for `Android`"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Notifies MoEngage SDK of device orientation change",
        "complexTypes": [],
        "slug": "onorientationchanged"
      },
      {
        "name": "passAuthenticationDetails",
        "signature": "(options: { authenticationData: MoEAuthenticationData; appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ authenticationData: MoEAuthenticationData; appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "since",
            "text": "7.1.0"
          }
        ],
        "docs": "Pass JWT authentication details to the native SDK (after login / token refresh).",
        "complexTypes": [
          "MoEAuthenticationData"
        ],
        "slug": "passauthenticationdetails"
      },
      {
        "name": "addListener",
        "signature": "(eventName: 'pushTokenGenerated', listenerFunc: MoEPushTokenListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
        "parameters": [
          {
            "name": "eventName",
            "docs": "",
            "type": "'pushTokenGenerated'"
          },
          {
            "name": "listenerFunc",
            "docs": "",
            "type": "MoEPushTokenListener"
          }
        ],
        "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
        "tags": [
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Listen for push token generated event",
        "complexTypes": [
          "PluginListenerHandle",
          "MoEPushTokenListener"
        ],
        "slug": "addlistenerpushtokengenerated-"
      },
      {
        "name": "addListener",
        "signature": "(eventName: 'pushClicked', listenerFunc: MoEPushClickListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
        "parameters": [
          {
            "name": "eventName",
            "docs": "",
            "type": "'pushClicked'"
          },
          {
            "name": "listenerFunc",
            "docs": "",
            "type": "MoEPushClickListener"
          }
        ],
        "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
        "tags": [
          {
            "name": "since",
            "text": "1.0.0"
          }
        ],
        "docs": "Listen for push clicked event",
        "complexTypes": [
          "PluginListenerHandle",
          "MoEPushClickListener"
        ],
        "slug": "addlistenerpushclicked-"
      },
      {
        "name": "addListener",
        "signature": "(eventName: 'inAppCampaignShown', listenerFunc: MoEInAppShownListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
        "parameters": [
          {
            "name": "eventName",
            "docs": "",
            "type": "'inAppCampaignShown'"
          },
          {
            "name": "listenerFunc",
            "docs": "",
            "type": "MoEInAppShownListener"
          }
        ],
        "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
        "tags": [
          {
            "name": "since",
            "text": "1.0.0"
          }
        ],
        "docs": "Listen for in-app campaign shown event",
        "complexTypes": [
          "PluginListenerHandle",
          "MoEInAppShownListener"
        ],
        "slug": "addlistenerinappcampaignshown-"
      },
      {
        "name": "addListener",
        "signature": "(eventName: 'inAppCampaignClicked', listenerFunc: MoEInAppClickedListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
        "parameters": [
          {
            "name": "eventName",
            "docs": "",
            "type": "'inAppCampaignClicked'"
          },
          {
            "name": "listenerFunc",
            "docs": "",
            "type": "MoEInAppClickedListener"
          }
        ],
        "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
        "tags": [
          {
            "name": "since",
            "text": "1.0.0"
          }
        ],
        "docs": "Listen for in-app campaign clicked event",
        "complexTypes": [
          "PluginListenerHandle",
          "MoEInAppClickedListener"
        ],
        "slug": "addlistenerinappcampaignclicked-"
      },
      {
        "name": "addListener",
        "signature": "(eventName: 'inAppCampaignDismissed', listenerFunc: MoEInAppDismissedListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
        "parameters": [
          {
            "name": "eventName",
            "docs": "",
            "type": "'inAppCampaignDismissed'"
          },
          {
            "name": "listenerFunc",
            "docs": "",
            "type": "MoEInAppDismissedListener"
          }
        ],
        "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
        "tags": [],
        "docs": "",
        "complexTypes": [
          "PluginListenerHandle",
          "MoEInAppDismissedListener"
        ],
        "slug": "addlistenerinappcampaigndismissed-"
      },
      {
        "name": "addListener",
        "signature": "(eventName: 'inAppCampaignCustomAction', listenerFunc: MoEInAppCustomActionListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
        "parameters": [
          {
            "name": "eventName",
            "docs": "",
            "type": "'inAppCampaignCustomAction'"
          },
          {
            "name": "listenerFunc",
            "docs": "",
            "type": "MoEInAppCustomActionListener"
          }
        ],
        "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
        "tags": [
          {
            "name": "since",
            "text": "1.0.0"
          }
        ],
        "docs": "Listen for in-app campaign custom action event",
        "complexTypes": [
          "PluginListenerHandle",
          "MoEInAppCustomActionListener"
        ],
        "slug": "addlistenerinappcampaigncustomaction-"
      },
      {
        "name": "addListener",
        "signature": "(eventName: 'inAppCampaignSelfHandled', listenerFunc: MoEInAppSelfHandledListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
        "parameters": [
          {
            "name": "eventName",
            "docs": "",
            "type": "'inAppCampaignSelfHandled'"
          },
          {
            "name": "listenerFunc",
            "docs": "",
            "type": "MoEInAppSelfHandledListener"
          }
        ],
        "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
        "tags": [
          {
            "name": "since",
            "text": "1.0.0"
          }
        ],
        "docs": "Listen for in-app campaign self handled available event\n\n`getSelfHandledInApp()` api call returns the available self handled in-app via this listener.",
        "complexTypes": [
          "PluginListenerHandle",
          "MoEInAppSelfHandledListener"
        ],
        "slug": "addlistenerinappcampaignselfhandled-"
      },
      {
        "name": "addListener",
        "signature": "(eventName: 'logoutCompleted', listenerFunc: MoELogoutCompleteListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
        "parameters": [
          {
            "name": "eventName",
            "docs": "",
            "type": "'logoutCompleted'"
          },
          {
            "name": "listenerFunc",
            "docs": "",
            "type": "MoELogoutCompleteListener"
          }
        ],
        "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
        "tags": [
          {
            "name": "since",
            "text": "7.0.0"
          }
        ],
        "docs": "Listen for logout complete event",
        "complexTypes": [
          "PluginListenerHandle",
          "MoELogoutCompleteListener"
        ],
        "slug": "addlistenerlogoutcompleted-"
      },
      {
        "name": "addListener",
        "signature": "(eventName: 'authenticationError', listenerFunc: MoEAuthenticationErrorListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
        "parameters": [
          {
            "name": "eventName",
            "docs": "",
            "type": "'authenticationError'"
          },
          {
            "name": "listenerFunc",
            "docs": "",
            "type": "MoEAuthenticationErrorListener"
          }
        ],
        "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
        "tags": [
          {
            "name": "since",
            "text": "7.1.0"
          }
        ],
        "docs": "Listen for authentication errors from the MoEngage SDK (e.g. JWT validation failures).",
        "complexTypes": [
          "PluginListenerHandle",
          "MoEAuthenticationErrorListener"
        ],
        "slug": "addlistenerauthenticationerror-"
      },
      {
        "name": "enableAdIdTracking",
        "signature": "(options: { appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "remarks",
            "text": "This API is only for `Android`"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Enables GAID tracking, by default GAID tracking is disabled.",
        "complexTypes": [],
        "slug": "enableadidtracking"
      },
      {
        "name": "disableAdIdTracking",
        "signature": "(options: { appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "remarks",
            "text": "This API is only for `Android`"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Disables GAID tracking.",
        "complexTypes": [],
        "slug": "disableadidtracking"
      },
      {
        "name": "enableAndroidIdTracking",
        "signature": "(options: { appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "remarks",
            "text": "This API is only for `Android`"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Enables Android ID tracking, by default ANdroid ID tracking is disabled.",
        "complexTypes": [],
        "slug": "enableandroididtracking"
      },
      {
        "name": "disableAndroidIdTracking",
        "signature": "(options: { appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "remarks",
            "text": "This API is only for `Android`"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Disables Android ID tracking.",
        "complexTypes": [],
        "slug": "disableandroididtracking"
      },
      {
        "name": "setupNotificationChannelsAndroid",
        "signature": "() => Promise<void>",
        "parameters": [],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "remarks",
            "text": "This API is only for `Android`"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "API to create notification channels on Android.",
        "complexTypes": [],
        "slug": "setupnotificationchannelsandroid"
      },
      {
        "name": "pushPermissionResponseAndroid",
        "signature": "(options: { isGranted: boolean; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ isGranted: boolean; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "remarks",
            "text": "This API is only for `Android`"
          },
          {
            "name": "param",
            "text": "isGranted true if the permission is granted else false"
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Notify the SDK on notification permission granted to the application.",
        "complexTypes": [],
        "slug": "pushpermissionresponseandroid"
      },
      {
        "name": "navigateToSettingsAndroid",
        "signature": "() => Promise<void>",
        "parameters": [],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "remarks",
            "text": "This API is only for `Android`"
          }
        ],
        "docs": "Navigates the user to the Notification settings on Android 8 or above,\non older versions the user is navigated the application settings or\napplication info screen.",
        "complexTypes": [],
        "slug": "navigatetosettingsandroid"
      },
      {
        "name": "requestPushPermissionAndroid",
        "signature": "() => Promise<void>",
        "parameters": [],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "remarks",
            "text": "This API is only for `Android`"
          }
        ],
        "docs": "Requests the push permission on Android 13 and above.",
        "complexTypes": [],
        "slug": "requestpushpermissionandroid"
      },
      {
        "name": "addListener",
        "signature": "(eventName: 'onPermissionResult', listenerFunc: MoEPermissionListener) => Promise<PluginListenerHandle> & PluginListenerHandle",
        "parameters": [
          {
            "name": "eventName",
            "docs": "",
            "type": "'onPermissionResult'"
          },
          {
            "name": "listenerFunc",
            "docs": "",
            "type": "MoEPermissionListener"
          }
        ],
        "returns": "Promise<PluginListenerHandle> & PluginListenerHandle",
        "tags": [
          {
            "name": "remarks",
            "text": "This API is only for `Android`\n\n`requestPushPermissionAndroid()` api call returns the state of permission via this listener."
          },
          {
            "name": "since",
            "text": "2.0.0"
          }
        ],
        "docs": "Listen for permission response",
        "complexTypes": [
          "PluginListenerHandle",
          "MoEPermissionListener"
        ],
        "slug": "addlisteneronpermissionresult-"
      },
      {
        "name": "enableDeviceIdTracking",
        "signature": "(options: { appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "Enable Device-id tracking. It is enabled by default and should be called only if tracking is disabled at some point.",
        "complexTypes": [],
        "slug": "enabledeviceidtracking"
      },
      {
        "name": "disableDeviceIdTracking",
        "signature": "(options: { appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [],
        "docs": "Disables Device-id tracking.",
        "complexTypes": [],
        "slug": "disabledeviceidtracking"
      },
      {
        "name": "updatePushPermissionRequestCountAndroid",
        "signature": "(options: { appId: string; count: number; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appId: string; count: number; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "remarks",
            "text": "This API is only for `Android`"
          },
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "param",
            "text": "count - Number of fresh request attempts."
          }
        ],
        "docs": "Updates the Notification request attempt count, the request attempt count will be\nincremented by the passed fresh count.\n\nNOTE: Call this API only when the Application is handling the Notification request\npermission.",
        "complexTypes": [],
        "slug": "updatepushpermissionrequestcountandroid"
      },
      {
        "name": "deleteUser",
        "signature": "(options: { appId: string; }, callback: MoEUserDeleteCallback) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appId: string; }"
          },
          {
            "name": "callback",
            "docs": "instance of {@link MoEUserDeleteCallback} to get the API response",
            "type": "MoEUserDeleteCallback"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "remarks",
            "text": "This API is only for `Android`"
          },
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "param",
            "text": "callback instance of {@link MoEUserDeleteCallback} to get the API response"
          }
        ],
        "docs": "Delete Current User Data From MoEngage Server",
        "complexTypes": [
          "MoEUserDeleteCallback"
        ],
        "slug": "deleteuser"
      },
      {
        "name": "showNudge",
        "signature": "(options: { position: MoENudgePosition; appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ position: MoENudgePosition; appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "position Place on the screen to show the Nudge."
          },
          {
            "name": "param",
            "text": "appId Account Identifier"
          }
        ],
        "docs": "Show Nudge",
        "complexTypes": [
          "MoENudgePosition"
        ],
        "slug": "shownudge"
      },
      {
        "name": "identifyUser",
        "signature": "(options: { identity: string | { [key: string]: string; }; appId: string; }) => Promise<void>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ identity: string | { [key: string]: string; }; appId: string; }"
          }
        ],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "param",
            "text": "identity Supported types: [String] and [Map<String, String>]"
          },
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "since",
            "text": "7.0.0"
          }
        ],
        "docs": "Identify User",
        "complexTypes": [],
        "slug": "identifyuser"
      },
      {
        "name": "getUserIdentities",
        "signature": "(options: { appId: string; }) => Promise<Map<String, String> | null>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appId: string; }"
          }
        ],
        "returns": "Promise<Map<String, String> | null>",
        "tags": [
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "returns",
            "text": "A Promise that resolves to an object containing user identities as key-value pairs\nReturns an empty object if no user identities are found.\nReturns null if an error occurred while fetching the user identities."
          },
          {
            "name": "since",
            "text": "7.0.0"
          }
        ],
        "docs": "Get User Identities",
        "complexTypes": [
          "Map",
          "String"
        ],
        "slug": "getuseridentities"
      },
      {
        "name": "getSelfHandledInApps",
        "signature": "(options: { appId: string; }) => Promise<MoEInAppSelfHandledCampaignsData>",
        "parameters": [
          {
            "name": "options",
            "docs": "",
            "type": "{ appId: string; }"
          }
        ],
        "returns": "Promise<MoEInAppSelfHandledCampaignsData>",
        "tags": [
          {
            "name": "param",
            "text": "appId Account Identifier"
          },
          {
            "name": "returns",
            "text": "Promise with campaigns data"
          },
          {
            "name": "since",
            "text": "7.0.0"
          }
        ],
        "docs": "Get Multiple self handled in-app campaigns",
        "complexTypes": [
          "MoEInAppSelfHandledCampaignsData"
        ],
        "slug": "getselfhandledinapps"
      },
      {
        "name": "registerForProvisionalPush",
        "signature": "() => Promise<void>",
        "parameters": [],
        "returns": "Promise<void>",
        "tags": [
          {
            "name": "remarks",
            "text": "This API is only for `iOS`"
          },
          {
            "name": "since",
            "text": "7.0.0"
          }
        ],
        "docs": "Register For Provisional Push Notifications for iOS",
        "complexTypes": [],
        "slug": "registerforprovisionalpush"
      }
    ],
    "properties": []
  },
  "interfaces": [
    {
      "name": "MoEInitConfig",
      "slug": "moeinitconfig",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "analyticsConfig",
          "tags": [],
          "docs": "Analytics Config data",
          "complexTypes": [
            "MoEAnalyticsConfig"
          ],
          "type": "MoEAnalyticsConfig"
        },
        {
          "name": "pushConfig",
          "tags": [],
          "docs": "Push Config data",
          "complexTypes": [
            "MoEPushConfig"
          ],
          "type": "MoEPushConfig"
        }
      ]
    },
    {
      "name": "MoEAnalyticsConfig",
      "slug": "moeanalyticsconfig",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "shouldTrackUserAttributeBooleanAsNumber",
          "tags": [],
          "docs": "Status of whether boolean user attribute should be tracked as number or not.",
          "complexTypes": [],
          "type": "boolean"
        }
      ]
    },
    {
      "name": "MoEPushConfig",
      "slug": "moepushconfig",
      "docs": "",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "shouldDeliverCallbackOnForegroundClick",
          "tags": [],
          "docs": "Whether to deliver callback when push notification is clicked in foreground",
          "complexTypes": [],
          "type": "boolean"
        }
      ]
    },
    {
      "name": "MoEProperties",
      "slug": "moeproperties",
      "docs": "User attributes object",
      "tags": [],
      "methods": [],
      "properties": [
        {
          "name": "generalAttributes",
          "tags": [],
          "docs": "General Attributes",
          "complexTypes": [
            "Array",
            "MoEGeneralAttributes"
          ],
          "type": "Array<MoEGeneralAttributes>"
        },
        {
          "name": "dateTimeAttributes",
          "tags": [],
          "docs": "Location Attributes",
          "complexTypes": [
            "Array",
            "MoEDateTimeAttributes"
          ],
          "type": "Array<MoEDateTimeAttributes>"
        },
        {
          "name": "locationAttributes",
          "tags": [],
          "docs": "Date time Attributes",
          "complexTypes": [
            "Array",
            "MoELocationAttributes"
          ],
          "type": "Array<MoELocationAttributes>"
        },
        {
          "name": "isNonInteractive",
          "tags": [],
          "docs": "Is the event non-interactive",
          "complexTypes": [],
          "type": "boolean | undefined"
        }
      ]
    },
    {
      "name":