The following API allows you to control when the session gets recorded.

Start Recording

Start the UXCam application to verify the API key with the server, get the settings configurations and start capturing the data according to the configuration.

NSUXCam.startWithKey: (appKey: string) => void

The API parameters are:
appKey: App-key (found on UXCam dashboard).

Stop Recording

UXCam automatically starts/stops sessions depending on application state. If you want to take control, use this API to stop UXCam session and upload it.

NSUXCam.stopSessionAndUploadData: () => void

Cancel Recording

Cancel the recording of the current session and discard the data.

NSUXCam.cancelCurrentSession: () => void

Allow a Short Break for Another App

Prevent a short trip to another app from causing a break in a session. This is useful when your user needs to leave the app for a short amount of time like log-in using google or when you open URL link using an external browser among other use cases.

NSUXCam.allowShortBreakForAnotherApp: (continueSession: boolean) => void

The API parameters are:
continueSession: Set to TRUE to continue the current session after a short trip out to another app. Default is FALSE - stops the session as soon as the app enters the background.

Note: Set to TRUE to continue the current session before a short trip out to another app, and set to FALSE after coming back to the app.

Configure Multisession Recordings

Configure whether UXCam is set to automatically record a new session when the app resumes from the background.

Set whether to automatically record multiple sessions or not. Default is TRUE.

NSUXCam.setMultiSessionRecord: (recordMultipleSessions: boolean) => void

Get current multi session recording status (whether app is set to record multiple sessions or not).

NSUXCam.getMultiSessionRecord: () => boolean

Delete Pending Records

Delete sessions that are awaiting to upload.

NSUXCam.deletePendingUploads: () => void

//get pending uploads count
NSUXCam.pendingSessionCount: () => number

Upload Pending Session

IOS only. Begin uploading pending sessions.

NSUXCam.uploadPendingSession: () => void