Cobrowse.io Docs
  • Getting started
  • SDK Installation
    • Web
    • iOS
    • Android
    • React Native
    • Flutter
    • .NET Mobile
    • macOS
    • Windows
  • SDK Features
    • Account config
    • Identify your devices
    • Use 6-digit codes
    • Redact sensitive data
    • Viewing PDFs
    • Universal Cobrowse
    • Customize the interface
      • Active session controls
      • 6-digit code screen
      • User consent dialog
      • Remote control consent dialog
      • Full device consent dialog
      • Localization / translation
    • Initiate sessions with push
    • Listening for events
    • Full device capabilities
      • Full device screen sharing
      • Full device remote control
      • Managing full device mode
    • Advanced configuration
      • Starting and stopping the SDK
      • Declaring capabilities
      • Intercepting mobile SDK network requests
      • Web
        • IFrames support
        • IE 11 polyfills
        • Cross-domain session support
        • Ignore Views
      • iOS
        • Alternate render method
        • Custom touch handling
      • Android
        • Backporting TLS to older Android versions
  • Agent-side integrations
    • Agent-side overview
    • Platform integrations
      • Zendesk
      • Salesforce
        • Migrating from legacy to v2
        • Salesforce (Legacy)
      • Genesys
        • Genesys Cloud
        • Engage Workspace Web Edition (WWE)
        • Engage Workspace Desktop Edition (WDE)
      • Intercom
      • Freshworks
      • Talkdesk
      • NICE
    • Custom integrations
    • Agent SDK
      • API Reference
      • Sample code snippets
    • Authentication (JWTs)
      • JWT Policies
    • Authentication (SAML 2.0)
    • IFrame embeds
  • Enterprise self-hosting
    • Self-hosting overview
    • Docker Compose
    • Helm chart
      • Image Pull Secret
      • Environment Variables
      • Optional recording components
      • Pod Annotations
    • AWS terraform
      • AWS metrics configuration
    • Azure terraform
      • Azure metrics configuration
    • GCP terraform
      • GCP metrics configuration
    • Sizing guidelines
    • Running your instance
      • Adding a superuser
      • Limiting account creation
      • Limiting magic link recipients
      • Configuring SMTP
      • Managing your deployment
    • Monitoring your instance
      • Available metrics
      • Self-Hosted Prometheus
    • Advanced configuration
      • Air gap configuration
      • Pin web SDK version
      • L7 firewall configuration
      • Docker proxy configuration
    • Troubleshooting
Powered by GitBook
On this page

Was this helpful?

  1. SDK Features
  2. Advanced configuration

Declaring capabilities

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

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 ];

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
Description

cursor

Should agent cursor be rendered on client side

disappearing_ink

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

drawing

Can the agent draw over the users screen

full_device

Is full device mode enabled

keypress

Can the agent generate key events

laser

Can the agent direct user with laser pointer

pointer

Can the agent point and click on things when in remote control mode

scroll

Can the agent scroll the page (web only)

select

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

CobrowseIO.capabilities = [ 'cursor', 'drawing', 'full_device', 'laser', 'scroll' ];

Disable full device mode

CobrowseIO.capabilities = [ 'cursor', 'drawing', 'keypress', 'laser', 'pointer', 'scroll', 'select' ];
PreviousStarting and stopping the SDKNextIntercepting mobile SDK network requests

Last updated 28 days ago

Was this helpful?