JavaScript API - CoBrowsing

Configuration

Learn how to configure the LiveView plugin. Go to Configuration

Manage CoBrowsing

Is Active

Returns a boolean value which shows if the CoBrowsing session is active/connected.

CV.cobrowse.sessionIsActive();

Start CoBrowsing

Starts the CoBrowsing session. A small UI interface is shown where the session id is visible and the CoBrowsing session can be deactivated.

CV.cobrowse.start();

Stop CoBrowsing

Stops the CoBrowsing session. The UI for closing the session is destroyed.

CV.cobrowse.stop();

Eventlistener

You can define your own listeners which are triggered at specific events.

CoBrowsing started

It is triggered when the user starts the CoBrowsing session.

CV.cobrowse.addCobrowsingStartedListener(function() {});

CoBrowsing stopped

It is triggered when the user stops the CoBrowsing session.

CV.cobrowse.addCobrowsingStoppedListener(function() {});

Clear CoBrowsing listener

Cleanup the added CoBrowing listener to avoid memory leaks.

CV.cobrowse.clearListener();