Module: kuollAPI

JavaScript Kuoll API. Allows to handle recording process. May be accessed as window.kuoll on any page that contains bootloader.js
Source:

Methods

(static) cancelRecord()

Deletes the record and stops the recording.
Deprecated:
  • Use finishRecord instead
Source:

(static) createIssue(typeopt, descriptionopt, stacktraceopt) → {Promise}

Persists current record and marks current moment of the record as Issue. Some issues are created automatically by unhandled Errors and console.error calls.
Parameters:
Name Type Attributes Default Description
type String <optional>
 "error" Type of created issue. Later you can group issues by type.
description String <optional>
 issue description.
stacktrace String <optional>
 issue stacktrace.
Source:
Returns:
Resolves to recording information is successfully created issue; Fails if recording isn't active
Type
Promise

(static) finishRecord()

Deprecated:
  • Stop recording and mark the record as finished. Placeholder for kuoll.stopRecord with no parameters.
Source:

(static) getRecordInfo() → {Promise}

Source:
Returns:
Resolves to recording information if it's available, fails otherwise
Type
Promise

(static) isRecordActive() → {Promise}

Check if the recording is active.
Source:
Returns:
Resolves to true, if the recording has been started and hasn't been stopped yet
Type
Promise

(static) restartRecord()

Finishes the record and starts new one for the same user.
Deprecated:
  • Use finishRecord instead
Source:

(static) setUserData()

Updates custom data attached to current user.
Parameters:
Name Type Attributes Description
params.userId String <optional>
params.userEmail String <optional>
params.orgId String <optional>
params.orgName String <optional>
Source:

(static) startRecord(params) → {Promise}

Turn Kuoll ON and start new record (if it is not started yet).
Parameters:
Name Type Description
params Object | String Object with API_KEY, User info (optional), User Organization info (optional). Or just string with your API_KEY.
Properties
Name Type Attributes Default Description
userId string <optional>
 id of User in your web application
userEmail string <optional>
 User email
orgId string <optional>
 User organization Id in your web application
orgName string <optional>
 User organization name in your web application
API_KEY string <optional>
 Your company API_KEY
saveStaticResources boolean <optional>
 false If enabled, save a copy of all static resources to Kuoll. Affects network performance.
notes string <optional>
 Any notes about the record
ignoreUrls string | Array.<string> <optional>
 an array of private URLs. XmlHttpRequests to these URL will not be recorded
startCallback startCallback <optional>
 callback to call after record has successfully started
localRecording boolean <optional>
 false Performance parameter. Persist records only when issue created.
createIssueOn object <optional>
 Specifies in which cases Kuoll must create new issue.
Properties
Name Type Attributes Default Description
Error boolean <optional>
 true if true, will create an issue whenever unhandled JS error occurs.
consoleError boolean <optional>
 false if true, will create an issue whenever error logged to console.error.
serverError boolean <optional>
 false if true, will create an issue whenever XHR responses with 500 error.
kuollUserId string <optional>
 id of User given by Kuoll
duration number <optional>
 record will be automatically finished after specified time in seconds
sequentsBatchSize number <optional>
 amount of sequents that are accumulated before sent to server
silentMode boolean <optional>
 false if true, no recording messages will be written to console
samplingFraction number | boolean <optional>
 1 fraction of users for which recording should be started. In other words, it's probability that this `startRecord` call will actually do anything. This doesn't take into account users for which recording cannot be started at all (due to unsupported browser or because recording is already started). So specified samplingFraction is applied only to the users that actually can be recorded. False is treated as 0 and true is treated as 1.
Source:
Returns:
Resolves to an object with info about started record if started successfully. Fails with an error message otherwise.
Type
Promise

(static) stopRecord(paramsopt) → {Promise}

Marks the record as finished and stops the recording.
Parameters:
Name Type Attributes Description
params object <optional>
Properties
Name Type Attributes Default Description
notes string <optional>
 User notes related to the record
restart boolean <optional>
 false if true, current record will be finished and new one started.
dontSave boolean <optional>
 false if true, current record will not be persisted to Kuoll servers and all already saved data will be erased.
Source:
Returns:
Resolves if recording is successfully stopped; If params.restart is true, resolves with a promise returned from kuoll.startRecord method. Fails with an error message if record cannot be stopped.
Type
Promise

Type Definitions

startCallback(kuollUserId, recordCode)

This callback will be called when record is successfully started.
Parameters:
Name Type Description
kuollUserId number
recordCode number
Source:

Documentation generated by JSDoc 3.3.3 on Wed May 24 2017 09:48:39 GMT+0300 (FLE Daylight Time)