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
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
initWithConfiguration(configuration, success, error)
Initializes the agent and starts instrumentation.
Parameters:
Name | Type | Description |
---|---|---|
configuration |
string | settings in json format |
success |
function | user defined success callback |
error |
function | user defined error callback |
- 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:
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:
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: