Lifecycle & Recording

Setup & start recording

Pre API 2.0

Smartlook.setupAndStartRecording(optionsOrAPIKey);

API 2.0

There is no explicit setup() method. The SDK is set up automatically.

Also, recording can be started even though the project key is not set yet. The recorded data will not be sent out till the project key is set but will be stored for the "future" send.

This can be beneficial when the project key is fetched from a server. In this scenario, the recording can be started right away (on the application start). The recording will be complete, the upload of recorded data is just postponed until the project key is set.

Smartlook.setProjectKey({key: "API_KEY"});
Smartlook.start();

Start recording and project key documentation.

Start & stop recording

Pre API 2.0

Smartlook.startRecording();
Smartlook.stopRecording();

API 2.0

Smartlook.start();
Smartlook.stop();

Start & stop recording documentation.

Check if the SDK is recording

Pre API 2.0

Smartlook.isRecording();

API 2.0

const isRecording = await Smartlook.isRecording();

Checking if the SDK is recording documentation.

Reset session/user

Pre API 2.0

// Reset session
Smartlook.resetSession(false);

// Reset session & user
Smartlook.resetSession(true);

API 2.0

// Open new session
Smartlook.openNewSession();

// Open new session & user
Smartlook.openNewUser();

Opening a new session documentation.
Opening a new user documentation.