Class: ADEUMMobilePlugin

ADEUMMobilePlugin()

new ADEUMMobilePlugin()

ADEUMMobilePlugin class.
Source:

Methods

beginCall(name, functionName, args, success, error) → {object}

Reports that an info point has started
Parameters:
Name Type Description
name string module or file name
functionName string
args string a string representation of the arguments
success function user defined success callback
error function user defined error callback
Source:
Returns:
tracker object that can be used to report end of info point
Type
object

beginHttpRequest(url, success, error) → {object}

Begins tracking an HTTP request
Parameters:
Name Type Description
url string The URL being requested
success function user defined success callback
error function user defined error callback
Source:
Returns:
tracker object that can be used to report request and response information as it becomes available.
Type
object

blockScreenshots(success, error)

Blocks screenshot capture if it is currently unblocked. Otherwise, this has no effect. If screenshots are disabled through --SCREENSHOTS_ENABLED=false command line parameter while adding the plugin or through the controller UI, this method has no effect. **WARNING:** This will block capture for the entire app. The user is expected to manage any possible nesting issues that may occur if blocking and unblocking occur in different code paths. See #unblockScreenshots()
Parameters:
Name Type Description
success function user defined success callback
error function user defined error callback
Source:

changeAppKey(appKey, success, error)

Change the App Key associated with the agent.
Parameters:
Name Type Description
appKey string
success function user defined success callback
error function user defined error callback
Source:

crash()

For internal testing only.
Source:

getVersion(success, error) → {string}

Returns plugin version.
Parameters:
Name Type Description
success function user defined success callback
error function user defined error callback
Source:
Returns:
Type
string

initWithAppKey()

Deprecated:
  • Please set the initialization parameters while adding the plugin to the app through command line arguments using the "--variable ="
Source:

initWithConfiguration(configuration, success, error)

Parameters:
Name Type Description
configuration string settings in json format
success function user defined success callback
error function user defined error callback
Deprecated:
  • Please set the initialization parameters while adding the plugin to the app through command line arguments using the "--variable =" Initializes the agent and starts instrumentation.
Source:

leaveBreadcrumb(breadcrumb, mode, success, error)

Leaves a breadcrumb that will appear in a crash report. Each crash report displays the most recent 99 breadcrumbs.
Parameters:
Name Type Description
breadcrumb string The string to include in the crash report and sessions. Truncated at 2048 characters and empty values are ignored.
mode number 0 - for crashes only or 1 - for crashes and sessions. Defaults to crashes if mode is not parseable.
success function user defined success callback
error function user defined error callback
Source:

removeUserData(key, success, error)

Removes user data set using setUserData.
Parameters:
Name Type Description
key string
success function user defined success callback
error function user defined error callback
Source:

reportMetricWithName(name, value, success, error)

Report a metric with name and value. Allowed characters are [A-Za-z\s0-9]. Illegal characters shall be replaced by their ASCII hex value.
Parameters:
Name Type Description
name string
value number if value is not a whole number an error will be returned.
success function user defined success callback
error function user defined error callback
Source:

screenshotsBlocked(success, error) → {boolean}

Returns whether screenshot capture is blocked
Parameters:
Name Type Description
success function user defined success callback
error function user defined error callback
Source:
Returns:
Type
boolean

setUserData(key, value, success, error)

Send custom name, value pair.
Parameters:
Name Type Description
key string
value string
success function user defined success callback
error function user defined error callback
Source:

startNextSession(success, error)

Starts next session and ends the current session. The session started using this API may be ended by inactivity timeout set in the Application Configuration, before the next call to this API. This API makes some practical assumptions about session lengths among end users. Excessive use of this API will cause sessions to be throttled (excessive use is >10 calls per minute per agent, subject to change)
Parameters:
Name Type Description
success function user defined success callback
error function user defined error callback
Source:

startTimerWithName(name, success, error)

Starts named timer. Allowed characters are [A-Za-z\s0-9]. Illegal characters shall be replaced by their ASCII hex value.
Parameters:
Name Type Description
name string
success function user defined success callback
error function user defined error callback
Source:

stopTimerWithName(name, success, error)

Stops named timer.
Parameters:
Name Type Description
name string
success function user defined success callback
error function user defined error callback
Source:

takeScreenshot(success, error)

Asynchronously takes a screenshot of the current Activity's window. If screenshots are disabled through configuration or through the controller UI, this method does nothing. This will capture everything, including personal information, so you must be cautious of when to take the screenshot. These screenshots will show up in the Sessions screen for this user.
Parameters:
Name Type Description
success function user defined success callback
error function user defined error callback
Source:

unblockScreenshots(success, error)

Unblocks screenshot capture if it is currently blocked. Otherwise, this has no effect. If screenshots are disabled through --SCREENSHOTS_ENABLED=false command line parameter while adding the plugin or through the controller UI, this method has no effect. If screenshots are set to manual mode in the controller UI, this method unblocks for manual mode only. **WARNING:** This will unblock capture for the entire app. The user is expected to manage any possible nesting issues that may occur if blocking and unblocking occur in different code paths. See #blockScreenshots()
Parameters:
Name Type Description
success function user defined success callback
error function user defined error callback
Source: