Declaring capabilities

Cobrowse allows for different levels of capabilities which can be enabled or disabled from the settings of the dashboard or SDKs.

circle-info

Account-level settings for remote control, full device screenshare, and others are available via your account dashboard. Declaring the supported capabilities on the SDK-side as described below is only necessary for fine-tuning or other advanced use cases.

Several of our capabilities, like full device or remote control, can be enabled or disabled from the Session Settings of the dashboard. However, you may wish to have greater control allowing for capabilities to be enabled for some use cases but disabled for another.

CobrowseIO.capabilities = [ 'cursor', ... some other capabilities ];
circle-info

CobrowseIO.capabilities = [ ... ]; must be called before CobrowseIO.start();

Any capability included in the array will be enabled. To disable a capability omit it from the array.

A full list of capabilities can be seen in the table below.

Capability
Tool
Description

laser

Can the agent direct the user with a laser pointer

disappearing_ink

Can the agent use the disappearing ink tool(web only)

drawing

Can the agent draw over the users screen

rectangles

Can the agent use the rectangle tool

arrows

Can the agent use the arrow tool

full_device

Is full device mode enabled

cursor

remote control

Should agent cursor be rendered on client side

keypress

remote control

Can the agent generate key events

pointer

remote control

Can the agent point and click on things

scroll

remote control

Can the agent scroll the page (web only)

select

remote control

Can the agent select text (web only)

universal

Is Universal Cobrowse enabled

Examples

Allow the agent to scroll but not enter any values or navigate

Disable full device mode

Last updated