{ "api": { "name": "CapacitorAxaMobileSdkPlugin", "slug": "capacitoraxamobilesdkplugin", "docs": "", "tags": [], "methods": [ { "name": "enableSDK", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [], "docs": "Use this API to enable SDK.\nThe SDK is enabled by default. You need to call this API\nonly if you called disableSDK earlier.", "complexTypes": [], "slug": "enablesdk" }, { "name": "disableSDK", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [], "docs": "Use this API to disable the SDK.\nWhen disabled, the SDK no longer does any tracking of the application,\nor user interaction.", "complexTypes": [], "slug": "disablesdk" }, { "name": "isSDKEnabled", "signature": "() => Promise<{ value: boolean; }>", "parameters": [], "returns": "Promise<{ value: boolean; }>", "tags": [], "docs": "Use this API to determine if the SDK is enabled or not.\n\nReturns a boolean value", "complexTypes": [], "slug": "issdkenabled" }, { "name": "getDeviceId", "signature": "() => Promise<{ value: string; }>", "parameters": [], "returns": "Promise<{ value: string; }>", "tags": [], "docs": "Use this API to get the unique device ID generated by the SDK\n\nReturns a device id value", "complexTypes": [], "slug": "getdeviceid" }, { "name": "getCustomerId", "signature": "() => Promise<{ value: string | null; }>", "parameters": [], "returns": "Promise<{ value: string | null; }>", "tags": [], "docs": "Use this API to get the customer ID for this session.\nReturns a customerId value. If the customer ID is not set, this API returns a null value.", "complexTypes": [], "slug": "getcustomerid" }, { "name": "setCustomerId", "signature": "(options: { customerId: string; }) => Promise<{ error: SDKError; }>", "parameters": [ { "name": "options", "docs": "", "type": "{ customerId: string; }" } ], "returns": "Promise<{ error: SDKError; }>", "tags": [ { "name": "param", "text": "customerId is a string containing the customer ID\nIf an empty string is passed, the customer iD is reset.\ncallback is a function which expects an (SDKError value)" } ], "docs": "Use this API to set the customer ID for this session.", "complexTypes": [ "SDKError" ], "slug": "setcustomerid" }, { "name": "setSessionAttribute", "signature": "(options: { name: string; value: string; }) => Promise<{ error: SDKError; }>", "parameters": [ { "name": "options", "docs": "", "type": "{ name: string; value: string; }" } ], "returns": "Promise<{ error: SDKError; }>", "tags": [ { "name": "param", "text": "name is a string containing the attribute name" }, { "name": "param", "text": "value is string containing the attribute value\ncallback is a function which expects an (SDKError value)" } ], "docs": "Use this API to set a custom session attribute.", "complexTypes": [ "SDKError" ], "slug": "setsessionattribute" }, { "name": "enterPrivateZone", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [], "docs": "Use this API to stop collecting potentially sensitive data.\n\nThe following data is not collected when the app enters a private zone\n - Screenshots\n - Location information including GPS and IP addresses\n - Value in the text entry fields", "complexTypes": [], "slug": "enterprivatezone" }, { "name": "exitPrivateZone", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [], "docs": "Use this API to start collecting all data again", "complexTypes": [], "slug": "exitprivatezone" }, { "name": "isInPrivateZone", "signature": "() => Promise<{ value: boolean; }>", "parameters": [], "returns": "Promise<{ value: boolean; }>", "tags": [], "docs": "Use this API to determine if the SDK is in a private zone.\n\nReturns a boolean value", "complexTypes": [], "slug": "isinprivatezone" }, { "name": "getAPMHeaders", "signature": "() => Promise<{ value: object | null; }>", "parameters": [], "returns": "Promise<{ value: object | null; }>", "tags": [], "docs": "Use this API to get the SDK computed APM header in key value format.\nReturns dictionary or map of key, value pairs\nReturns an empty string if apm header cannot be computed", "complexTypes": [], "slug": "getapmheaders" }, { "name": "addToAPMHeader", "signature": "(options: { data: string; }) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "{ data: string; }" } ], "returns": "Promise", "tags": [ { "name": "param", "text": "data is a non-empty string in the form of \"key=value\".\ndata will be appended to the APM header separated by a semicolon (;)." } ], "docs": "Use this API to add custom data to the SDK computed APM header.", "complexTypes": [], "slug": "addtoapmheader" }, { "name": "setSSLPinningMode", "signature": "(options: { pinningMode: CAMDOSSLPinningMode; pinnedValues: string[]; }) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "{ pinningMode: CAMDOSSLPinningMode; pinnedValues: string[]; }" } ], "returns": "Promise", "tags": [ { "name": "param", "text": "pinningMode is one of the CAMDOSSLPinning modes described below" }, { "name": "param", "text": "pinnedValues is an array as required by the pinning mode\n\nSupported pinning modes:\nCAMDOSSLPinningModePublicKey OR CAMDOSSLPinningModeCertificate\n- array of certificate data (NSData from SeccertificateRef)\n- or, certificate files(.cer) to be present in the resource bundle\n\nCAMDOSSLPinningModeFingerPrintSHA1Signature\n- array of SHA1 fingerprint values\n\nCAMDOSSLPinningModePublicKeyHash\n- array of PublicKeyHashValues" } ], "docs": "Use this API to set the ssl pinning mode and array of pinned values.\nThis method expects array of values depending on the pinningMode", "complexTypes": [ "CAMDOSSLPinningMode" ], "slug": "setsslpinningmode" }, { "name": "stopCurrentSession", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [], "docs": "Use this API to stop the current session.\nNo data will be logged until the startSession API is called", "complexTypes": [], "slug": "stopcurrentsession" }, { "name": "startNewSession", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [], "docs": "Use this API to start a new session.\nIf a session is already in progress, it will be stopped and new session is started", "complexTypes": [], "slug": "startnewsession" }, { "name": "stopCurrentAndStartNewSession", "signature": "() => Promise", "parameters": [], "returns": "Promise", "tags": [], "docs": "Convenience API to stop the current session in progress and start a new session\nEquivalent to calling stopCurrentSession() and startNewSession()", "complexTypes": [], "slug": "stopcurrentandstartnewsession" }, { "name": "startApplicationTransaction", "signature": "(options: { transactionName: string; serviceName?: string; }) => Promise<{ completed: boolean; error: string | null; }>", "parameters": [ { "name": "options", "docs": "", "type": "{ transactionName: string; serviceName?: string | undefined; }" } ], "returns": "Promise<{ completed: boolean; error: string | null; }>", "tags": [ { "name": "param", "text": "transactionName is a string to indicate the transaction being processed" }, { "name": "param", "text": "serviceName is a string to indicate the service or application being applied\nReturns a callback\n\nIf successful, completed = YES and error is nil.\nIn case of failure, completed = NO and error will have NSError object with\ndomain, code and localizedDescription." } ], "docs": "Use this API to start a transaction with a specific name", "complexTypes": [], "slug": "startapplicationtransaction" }, { "name": "stopApplicationTransaction", "signature": "(options: { transactionName: string; failure?: string; }) => Promise<{ completed: boolean; error: string | null; }>", "parameters": [ { "name": "options", "docs": "", "type": "{ transactionName: string; failure?: string | undefined; }" } ], "returns": "Promise<{ completed: boolean; error: string | null; }>", "tags": [ { "name": "param", "text": "transactionName is a string to indicate the transaction being processed" }, { "name": "param", "text": "failureString is a string to indicate the failure name, message or type\nReturns a callback\n\nIf successful, completed = YES and error is nil.\nIn case of failure, completed = NO and error will have NSError object with\ndomain, code and localizedDescription." } ], "docs": "Use this API to stop a transaction with a specific name and an optional failure string", "complexTypes": [], "slug": "stopapplicationtransaction" }, { "name": "setCustomerFeedback", "signature": "(options: { feedback: string; }) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "{ feedback: string; }" } ], "returns": "Promise", "tags": [ { "name": "param", "text": "feedback is a string containing any customer feedback for the crash\n\nThe App has to register for CAMAA_CRASH_OCCURRED notification\nand collect the feedback from the user while handling the notification" } ], "docs": "Use this API to provide feedback from the user after a crash", "complexTypes": [], "slug": "setcustomerfeedback" }, { "name": "setCustomerLocation", "signature": "(options: { postalCode: string; countryCode: string; }) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "{ postalCode: string; countryCode: string; }" } ], "returns": "Promise", "tags": [ { "name": "param", "text": "postalCode is the country's postal code, e.g. zip code in the US" }, { "name": "param", "text": "countryCode is the two letter international code for the country" } ], "docs": "Use this API to set Location of the Customer/User\nusing postalCode and countryCode.", "complexTypes": [], "slug": "setcustomerlocation" }, { "name": "sendScreenShot", "signature": "(options: { name: string; quality: CAMDOSDKImageQualityType; }) => Promise<{ completed: boolean; error: string | null; }>", "parameters": [ { "name": "options", "docs": "", "type": "{ name: string; quality: CAMDOSDKImageQualityType; }" } ], "returns": "Promise<{ completed: boolean; error: string | null; }>", "tags": [ { "name": "param", "text": "name is a string to indicate the desired name for the screen" }, { "name": "param", "text": "quality is a CAMDOSDKImageQualityType indicating the quality of the image\nThe following values for imageQuality are defined:\n- CAMAA_SCREENSHOT_QUALITY_HIGH\n- CAMAA_SCREENSHOT_QUALITY_MEDIUM\n- CAMAA_SCREENSHOT_QUALITY_LOW\n- CAMAA_SCREENSHOT_QUALITY_DEFAULT\n\nThe default value is CAMAA_SCREENSHOT_QUALITY_LOW.\n\nReturns a callback\n\nIf successful, completed = YES and error is nil.\nIn case of failure, completed = NO and error will have NSError object with\ndomain, code and localizedDescription." } ], "docs": "Use this API to send a screen shot of the current screen", "complexTypes": [ "CAMDOSDKImageQualityType" ], "slug": "sendscreenshot" }, { "name": "viewLoaded", "signature": "(options: { viewName: string; loadTime: number; screenShot?: boolean; }) => Promise<{ completed: boolean; error: string | null; }>", "parameters": [ { "name": "options", "docs": "", "type": "{ viewName: string; loadTime: number; screenShot?: boolean | undefined; }" } ], "returns": "Promise<{ completed: boolean; error: string | null; }>", "tags": [ { "name": "param", "text": "viewName is the name of the view that was loaded" }, { "name": "param", "text": "loadTime is the time it took to load the view\nReturns a callback\n\nIf successful, completed = YES and error is nil.\nIn case of failure, completed = NO and error will have NSError object with\ndomain, code and localizedDescription." } ], "docs": "Use this API to create a custom app flow with dynamic views", "complexTypes": [], "slug": "viewloaded" }, { "name": "ignoreView", "signature": "(options: { viewName: string; }) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "{ viewName: string; }" } ], "returns": "Promise", "tags": [ { "name": "param", "text": "viewName is Name of the view to be ignored\nScreenshots and transitions of the views that are in ignore list are not captured" } ], "docs": "Use this API to set the name of a view to be ignored", "complexTypes": [], "slug": "ignoreview" }, { "name": "ignoreViews", "signature": "(options: { viewNames: string[]; }) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "{ viewNames: string[]; }" } ], "returns": "Promise", "tags": [ { "name": "param", "text": "viewNames is a list (an array) of names of the views to be ignored.\nScreenshots and transitions of the views that are in the\nignore list are not captured" } ], "docs": "Use this API to provide a list of view names to be ignored.", "complexTypes": [], "slug": "ignoreviews" }, { "name": "isScreenshotPolicyEnabled", "signature": "() => Promise<{ value: boolean; }>", "parameters": [], "returns": "Promise<{ value: boolean; }>", "tags": [], "docs": "Use this API to determine if automatic screenshots are enabled by policy.\n\nReturns a boolean value\nReturns YES if screenshots are enabled by policy. Otherwise returns NO", "complexTypes": [], "slug": "isscreenshotpolicyenabled" }, { "name": "logNetworkEvent", "signature": "(options: { url: string; status: number; responseTime: number; inBytes: number; outBytes: number; }) => Promise<{ completed: boolean; error: string | null; }>", "parameters": [ { "name": "options", "docs": "", "type": "{ url: string; status: number; responseTime: number; inBytes: number; outBytes: number; }" } ], "returns": "Promise<{ completed: boolean; error: string | null; }>", "tags": [ { "name": "param", "text": "url is a string reprentation of the network URL to be logged" }, { "name": "param", "text": "status is an integer value indicating the status, e.g. 200, 404, etc." }, { "name": "param", "text": "responseTime is an integer value representing the response time" }, { "name": "param", "text": "inBytes is an integer value representing the number of bytes input" }, { "name": "param", "text": "outBytes is an integer value representing the number of bytes output\nReturns a callback\n\nIf successful, completed = YES and error is nil.\nIn case of failure, completed = NO and error will have NSError object with\ndomain, code and localizedDescription." } ], "docs": "Use this API to add a custom network event in the current session", "complexTypes": [], "slug": "lognetworkevent" }, { "name": "logTextMetric", "signature": "(options: { textMetricName: string; value: string; attributes?: object; }) => Promise<{ completed: boolean; error: string | null; }>", "parameters": [ { "name": "options", "docs": "", "type": "{ textMetricName: string; value: string; attributes?: object | undefined; }" } ], "returns": "Promise<{ completed: boolean; error: string | null; }>", "tags": [ { "name": "param", "text": "textMetricName is a string to indicate a text metric name" }, { "name": "param", "text": "textMetricValue is a string to indicate a text metric value" }, { "name": "param", "text": "attributes is a Map or Dictionary used to send any extra parameters\nReturns a callback\n\nIf successful, completed = YES and error is nil.\nIn case of failure, completed = NO and error will have NSError object with\ndomain, code and localizedDescription." } ], "docs": "Use this API to add a custom text metric in the current session", "complexTypes": [], "slug": "logtextmetric" }, { "name": "logNumericMetric", "signature": "(options: { numericMetricName: string; value: number; attributes?: object; }) => Promise<{ completed: boolean; error: string | null; }>", "parameters": [ { "name": "options", "docs": "", "type": "{ numericMetricName: string; value: number; attributes?: object | undefined; }" } ], "returns": "Promise<{ completed: boolean; error: string | null; }>", "tags": [ { "name": "param", "text": "numericMetricName is a string to indicate a numeric metric name" }, { "name": "param", "text": "numericMetricValue is a numeric value, e.g. 3.14159, 2048.95, or 42, etc." }, { "name": "param", "text": "attributes is a Map or Dictionary used to send any extra parameters\nReturns a callback\n\nIf successful, completed = YES and error is nil.\nIn case of failure, completed = NO and error will have NSError object with\ndomain, code and localizedDescription." } ], "docs": "Use this API to add a custom numeric metric value in the current session", "complexTypes": [], "slug": "lognumericmetric" }, { "name": "uploadEvents", "signature": "() => Promise<{ response: object; error: string | null; }>", "parameters": [], "returns": "Promise<{ response: object; error: string | null; }>", "tags": [ { "name": "param", "text": "callback is a function which expects a response object and an error object\n\nReturns:\n- response is a key,value paired map or dictionary object\nthe Key 'CAMDOResponseKey' holds any URLResponse information\nthe key 'CAMDOTotalUploadedEvents' holds the total number of events uploaded\n- error is nil if the API call is successful, otherwise is an NSError object\nwith domain, code and localizedDescription." } ], "docs": "Use this API to force an upload event.\nThis is bulk/resource consuming operation and should be used with caution", "complexTypes": [], "slug": "uploadevents" }, { "name": "addListener", "signature": "(eventName: CAMAA_NOTIFICATION_TYPE.CAMAA_CRASH_OCCURRED, listenerFunc: () => void) => Promise & PluginListenerHandle", "parameters": [ { "name": "eventName", "docs": "", "type": "CAMAA_NOTIFICATION_TYPE.CAMAA_CRASH_OCCURRED" }, { "name": "listenerFunc", "docs": "", "type": "() => void" } ], "returns": "Promise & PluginListenerHandle", "tags": [], "docs": "", "complexTypes": [ "PluginListenerHandle", "CAMAA_NOTIFICATION_TYPE" ], "slug": "addlistenercamaa_notification_typecamaa_crash_occurred-" }, { "name": "addListener", "signature": "(eventName: CAMAA_NOTIFICATION_TYPE.CAMAA_UPLOAD_INITIATED, listenerFunc: () => void) => Promise & PluginListenerHandle", "parameters": [ { "name": "eventName", "docs": "", "type": "CAMAA_NOTIFICATION_TYPE.CAMAA_UPLOAD_INITIATED" }, { "name": "listenerFunc", "docs": "", "type": "() => void" } ], "returns": "Promise & PluginListenerHandle", "tags": [], "docs": "", "complexTypes": [ "PluginListenerHandle", "CAMAA_NOTIFICATION_TYPE" ], "slug": "addlistenercamaa_notification_typecamaa_upload_initiated-" }, { "name": "logUIEvent", "signature": "(options: { eventType: CAMDOUIEventType; value: string; }) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "{ eventType: CAMDOUIEventType; value: string; }" } ], "returns": "Promise", "tags": [], "docs": "", "complexTypes": [ "CAMDOUIEventType" ], "slug": "loguievent" }, { "name": "setNSURLSessionDelegate", "signature": "(options: { delegate: string; }) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "{ delegate: string; }" } ], "returns": "Promise", "tags": [ { "name": "param", "text": "delegate is an iOS native object or module which responds to the NSURLSessionDelegate protocols." } ], "docs": "Use this API to set your delegate instance to handle auth challenges.\nUse it when using SDKUseNetworkProtocolSwizzling option", "complexTypes": [], "slug": "setnsurlsessiondelegate" }, { "name": "setLocation", "signature": "(options: { latitude: number; longitude: number; }) => Promise", "parameters": [ { "name": "options", "docs": "", "type": "{ latitude: number; longitude: number; }" } ], "returns": "Promise", "tags": [ { "name": "param", "text": "latitude is the geographic latitude from -90.0 to 90.0 degrees" }, { "name": "param", "text": "logitude is the geographic longitude from -180.0 to 180.0 degrees" } ], "docs": "Use this API to set Geographic or GPS Location of the Customer", "complexTypes": [], "slug": "setlocation" }, { "name": "enableScreenShots", "signature": "(captureScreen: boolean) => Promise", "parameters": [ { "name": "captureScreen", "docs": "is a boolean value to enable/disable automatic screen captures.\n\nNormally the policy determines whether automatic screen captures are performed.\nUse this API to override the policy, or the current setting of this flag.", "type": "boolean" } ], "returns": "Promise", "tags": [ { "name": "param", "text": "captureScreen is a boolean value to enable/disable automatic screen captures.\n\nNormally the policy determines whether automatic screen captures are performed.\nUse this API to override the policy, or the current setting of this flag." } ], "docs": "Use this API to programmatically enable or disable automatic screen captures.", "complexTypes": [], "slug": "enablescreenshots" }, { "name": "induceNativeCrash", "signature": "(options: { crashType: string; }) => void", "parameters": [ { "name": "options", "docs": "", "type": "{ crashType: string; }" } ], "returns": "void", "tags": [], "docs": "This is a SDK Dev API", "complexTypes": [], "slug": "inducenativecrash" } ], "properties": [] }, "interfaces": [ { "name": "PluginListenerHandle", "slug": "pluginlistenerhandle", "docs": "", "tags": [], "methods": [], "properties": [ { "name": "remove", "tags": [], "docs": "", "complexTypes": [], "type": "() => Promise" } ] } ], "enums": [ { "name": "SDKError", "slug": "sdkerror", "members": [ { "name": "ErrorNone", "tags": [], "docs": "" }, { "name": "ErrorNoTransactionName", "tags": [], "docs": "" }, { "name": "ErrorTransactionInProgress", "tags": [], "docs": "" }, { "name": "ErrorFailedToTakeScreenshot", "tags": [], "docs": "" }, { "name": "ErrorInvalidValuesPassed", "tags": [], "docs": "" } ] }, { "name": "CAMDOSSLPinningMode", "slug": "camdosslpinningmode", "members": [ { "name": "CAMDOSSLPinningModeNone", "tags": [], "docs": "" }, { "name": "CAMDOSSLPinningModePublicKey", "tags": [], "docs": "" }, { "name": "CAMDOSSLPinningModeCertificate", "tags": [], "docs": "" }, { "name": "CAMDOSSLPinningModeFingerPrintSHA1Signature", "tags": [], "docs": "" }, { "name": "CAMDOSSLPinningModePublicKeyHash", "tags": [], "docs": "" } ] }, { "name": "CAMDOSDKImageQualityType", "slug": "camdosdkimagequalitytype", "members": [ { "name": "CAMAA_SCREENSHOT_QUALITY_HIGH", "value": "'CAMAA_SCREENSHOT_QUALITY_HIGH'", "tags": [], "docs": "" }, { "name": "CAMAA_SCREENSHOT_QUALITY_MEDIUM", "value": "'CAMAA_SCREENSHOT_QUALITY_MEDIUM'", "tags": [], "docs": "" }, { "name": "CAMAA_SCREENSHOT_QUALITY_LOW", "value": "'CAMAA_SCREENSHOT_QUALITY_LOW'", "tags": [], "docs": "" }, { "name": "CAMAA_SCREENSHOT_QUALITY_DEFAULT", "value": "'CAMAA_SCREENSHOT_QUALITY_DEFAULT'", "tags": [], "docs": "" } ] }, { "name": "CAMAA_NOTIFICATION_TYPE", "slug": "camaa_notification_type", "members": [ { "name": "CAMAA_UPLOAD_INITIATED", "value": "'CAMAA_UPLOAD_INITIATED'", "tags": [], "docs": "" }, { "name": "CAMAA_CRASH_OCCURRED", "value": "'CAMAA_CRASH_OCCURRED'", "tags": [], "docs": "" } ] }, { "name": "CAMDOUIEventType", "slug": "camdouieventtype", "members": [ { "name": "CAMAA_EVENT_BUTTON_PRESSED", "value": "'button_pressed'", "tags": [], "docs": "" }, { "name": "CAMAA_AI_START", "value": "'ai_start'", "tags": [], "docs": "" }, { "name": "CAMAA_AI_END", "value": "'ai_end'", "tags": [], "docs": "" }, { "name": "CAMAA_EVENT_DATE_PICKER_VIEW_SELECTED", "value": "'date_picker_selected'", "tags": [], "docs": "" }, { "name": "CAMAA_EVENT_PAGE_CHANGED", "value": "'page_changed'", "tags": [], "docs": "" }, { "name": "CAMAA_EVENT_SEGMENTED_CONTROL_PRESSED", "value": "'segment_control_pressed'", "tags": [], "docs": "" }, { "name": "CAMAA_EVENT_SLIDER_MOVED", "value": "'slider_moved'", "tags": [], "docs": "" }, { "name": "CAMAA_EVENT_STEPPER_PRESSED", "value": "'stepper_pressed'", "tags": [], "docs": "" }, { "name": "CAMAA_EVENT_SWITCH_PRESSED", "value": "'switch_pressed'", "tags": [], "docs": "" }, { "name": "CAMAA_EVENT_RADIO_BUTTON_PRESS", "value": "\"radio_button_pressed\"", "tags": [], "docs": "" }, { "name": "CAMAA_EVENT_CHECK_BOX_PRESS", "value": "\"check_box_pressed\"", "tags": [], "docs": "" }, { "name": "CAMAA_EVENT_SPINNER_ITEM_SELECTED", "value": "\"spinner_item_selected\"", "tags": [], "docs": "" }, { "name": "CAMAA_EVENT_TOGGLE_PRESS", "value": "\"switch_pressed\"", "tags": [], "docs": "" }, { "name": "CAMAA_EVENT_UNSUPPORTED", "value": "\"unknow_action\"", "tags": [], "docs": "" } ] } ], "typeAliases": [], "pluginConfigs": [] }