Contents
Commands
start
Start a Co-browse session
Resolutions
| Status | When | Returns |
|---|---|---|
| resolved | Co-browse API is available and used to start session | n/a |
| rejected | Co-browser API is not available | n/a |
stop
Stop the currently active Co-browse session
Resolutions
| Status | When | Returns |
|---|---|---|
| resolved | Co-browse API is available and used to end the active session | n/a |
| rejected | Co-browser API is not available | n/a |
configure
Modify configuration options for CoBrowse. See configuration page for CoBrowse.
Options
| Option | Type | Description |
|---|---|---|
| src | string | URL/Path to the Co-browse JavaScript package. Usually resides on the Co-browse server. |
| url | string | URL/Path to the Co-browse server endpoint. |
Resolutions
| Status | When | Returns |
|---|---|---|
| resolved | When configuration options are provided and set | n/a |
| rejected | When no configuration options are provided | 'Invalid configuration' |
Comments or questions about this documentation? Contact us for support!
