Opt-in / Opt-out

The SDK by default opts-in users for UXCam recording on app installs. You can now disable and enable recording at runtime by the following API.

Opt out a User

This method stops and deletes the session in progress (if any) and disables the recording of future sessions from this user.

Use this if:

• The user has chosen not to enable analytics (screen recording)

UXCam.optOutOverall()

UXCam.optOutOverall()

RNUxcam.optOutOverall: () => void

void optOutOverall()

void UXCam.OptOutOverall()

UXCam.optOutOverall: () => void

📘

The optIn/optOut setting resets to opt-In if the user un-installs and re-installs the app or clears app data.

Opt in a User

The SDK by default opts-in users for UXCam recording on app installs. If the user has been disabled for UXCam recording by using the optOut method, you can use this method to enable recording at runtime.

UXCam.optInOverall()

UXCam.optInOverall()

RNUxcam.optInOverall: () => void

void optInOverall()

void UXCam.OptInOverall()

UXCam.optInOverall: () => void

Opt in Status

This method returns the status of the user indicating whether they are currently opted in or opted out.

UXCam.optInOverallStatus()->Bool

boolean UXCam.optInOverallStatus()

const status = await RNUxcam.optInOverallStatus(); ==> boolean

Future<bool> optInOverallStatus()

bool UXCam.optInOverallStatus()

UXCam.optInOverallStatus: () => boolean