Skip to main content
Skip to main content
Sign In Get Support

Hi, how can we help?

Start and control recording

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

Start recording

Start the UXCam application to ping the server, get the settings configurations and start capturing the data according to the configuration. 

Use startWithKey with appVariantIdentifier parameter to separate Debug and Release builds.

(void) startWithKey:(NSString*)UXCamKey 
UXCam.startWithKey (String UXCamKey)

UXCam.StartWithKey(UXCamKey);

UXCam.startWithKey(UXCamKey);

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

Stop recording

Stop the UXCam application and send the captured data to the server. You can use this code to start sending the data on UXCam server without the app going in the background. 

(void) stopSessionAndUploadData; 
UXCam.stopApplicationAndUploadSession();

UXCam.StopSessionAndUploadData();
UXCam.stopSessionAndUploadData();

Allow a short break for another app

Prevent a short trip to another app from causing a break in a session.

+(void) allowShortBreakForAnotherApp:(BOOL)continueSession;

UXCam.allowShortBreakForAnotherApp(true)

** call UXCam.allowShortBreakForAnotherApp(false) to resume from short break
** By default the method will wait 180000ms (3min) to end the session, if you want to specify the time call UXCam.allowShortBreakForAnotherApp(int timeInMillis)
UXCam.AllowShortBreakForAnotherApp(continueSession)

** Android only: call UXCam.ResumeShortBreakForAnotherApp() to resume from short break

UXCam.allowShortBreakForAnotherApp(continueSession)

** call UXCam.resumeShortBreakForAnotherApp() to resume from short break

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.

Cancel recording

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

+ (void) cancelCurrentSession;

UXCam.cancelCurrentSession()
UXCam.CancelCurrentSession()

UXCam.cancelCurrentSession()

Add verification listener

Doesn't exist on iOS - pass it in to startWithKey

UXCam.addVerificationListener(OnVerificationListener listener)

Example:
        UXCam.addVerificationListener(new OnVerificationListener() {
            @Override
            public void onVerificationSuccess() {
                //Do Something here
            }

            @Override
            public void onVerificationFailed(String errorMessage) {
                //Do Something here
            }
        });
UXCam.AddVerificationListener(OnVerificationListener listener)

Example:
        UXCam.AddVerificationListener(new IOnVerificationListener());
                class IOnVerificationListener : Java.Lang.Object, Com.UXCam.IOnVerificationListener
                {
                        public void OnVerificationFailed(string p0)
                        {
                                    //Do Something here
                        }

                        public void OnVerificationSuccess()
                        {
                                   //Do Something here
                        }
                }

UXCam.addVerificationListener(OnVerificationListener listener)

Example:
UXCam.addVerificationListener(verificationSuccess);
function verificationSuccess() {
    UXCam.urlForCurrentUser(function(link){
        //Do Something here
    });
    UXCam.urlForCurrentSession(function(link){
        //Do something here
    });
}

Remove verification listener

Doesn't exist on iOS

UXCam.removeVerificationListener(OnVerificationListener listener)
UXCam.RemoveVerificationListener(OnVerificationListener listener)

UXCam.removeVerificationListener(OnVerificationListener listener)

Configure Multisession Recordings

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

+ (BOOL) getMultiSessionRecord;

boolean getMultiSessionRecord()
boolean GetMultiSessionRecord()

boolean getMultiSessionRecord()

Set Multisession Recording

Set whether to automatically record multiple sessions or not.

+ (void) setMultiSessionRecord:(BOOL)recordMultipleSessions;

void setMultiSessionRecord(boolean multiSessionRecord)
void SetMultiSessionRecord()

void setMultiSessionRecord()

Delete pending records

Delete sessions that are awaiting to upload

+ (void) deletePendingUploads;
+ (NSUInteger) pendingUploads;

void deletePendingUploads()
int pendingSessionCount();
void DeletePendingUploads()
int PendingSessionCount()

void deletePendingUploads()
int pendingSessionCount()

Upload pending session

Begin uploading pending sessions.

void uploadPendingSession()
void uploadPendingSession(Callback callback)

NO
IOS Only:
void UploadPendingSession()
void UploadPendingSession(Callback callback)

IOS only:
void uploadPendingSession()
void uploadPendingSession(Callback callback)