search
HomeDashboardAPI DocsBook A Demo

Start and Stop Cobrowsing

Starting the SaleAssist Cobrowse SDK is often done early in your application. However, you have the ability to delay the start of the SDK or programmatically stop the SDK so that it runs only when needed.

hashtag
Starting the SDK

await CobrowseIO.client();
await CobrowseIO.start();
circle-info

If you do decide to delay or lazy load the SDK it is important to check if there is a currently active session and if so load and start the SDK right away. Without this check sessions would not continue between navigation or page refreshes as the SDK won't be loaded.

// On page load check if we should start the Cobrowse SDK right away

if (CobrowseIO.currrentSession) {

await CobrowseIO.client();

await CobrowseIO.start();

}

hashtag
Automatic registration

By default, when the SDK starts it will register the device to your account and share its connectivity state. This provides the dashboard with a list of devices which are online and ready to connect.

If you don't need to see a list of devices in your dashboard, e.g. your sessions start only using 6-digit codes, then you can stop the SDK from registering the device and its connectivity status by setting the registration option with a value of false.

CobrowseIO.registration = false;

hashtag
Stopping the SDK

Calling stop() will stop Cobrowsing completely and you won't be able to Cobrowse again until you call start(). If you only wish to end a session please use end() method on the Session object.

await CobrowseIO.stop();

PreviousRedact sensitive dataNextListening for events

Last updated