Control Recording

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

Start a New Recording

Start the UXCam application after having previously stopped it to verify the API key with the server, get the settings configurations and start capturing the data according to the configuration if you previously stopped it.

UXCam.startNewSession()

UXCam.startNewSession()

RNUxcam.startNewSession()

void startNewSession()

UXCam.StartNewSession()

UXCam.startNewSession()

UXCamCore.startNewSession()

Stop Recording

UXCam automatically stops a session when the app goes to the background. Using this API you are going to be able to stop a session and upload it.

This is useful for:

Recording a specific flow without sending the application to the background.
Sending data (events, gestures, etc.) in a session without the closure of an app.

UXCam.stopSessionAndUploadData()

//With completion handler
UXCam.stopSessionAndUploadData(_ block: (() -> Void)? = nil)

UXCam.stopSessionAndUploadData();

RNUxcam.stopSessionAndUploadData: () => void

void stopSessionAndUploadData()

void UXCam.StopSessionAndUploadData()

UXCam.stopSessionAndUploadData: () => void

UXCamCore.stopSessionAndUploadData()

//With completion handler
UXCamCore.stopSessionAndUploadData(_ block: (() -> Void)? = nil)

Add Verification Listener

With this API you are going to be able to get the verification status when UXCam starts recording a session.

By getting this you are going to be able to:

Send events to UXCam as soon as the session starts.
Log the current UXCam session URL or the user URL to other 3rd party services such as Firebase.

Doesn't exist on iOS - use startWithKey with completion handler.

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
        }
    });

//To remove
UXCam.removeVerificationListener(OnVerificationListener listener);

import { NativeModules, NativeEventEmitter } from 'react-native';

const emitter = new NativeEventEmitter(NativeModules.RNUxcam)
this.uxcamListener = emitter.addListener('UXCam_Verification_Event', async (status) => {
    if (status.success){
        //Do Something here
    }
})

//To remove
uxcamListener.remove()

Not supported

//Android only - use callback action for iOS.
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
        }
    }

//To remove
UXCam.RemoveVerificationListener(OnVerificationListener listener);

Not supported