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()

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

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