Supported Events
The supported events can be accessed using the Cobrowse.Events object.
N |
Event Name |
Properties |
Description |
|---|---|---|---|
1 |
SessionStarting |
This event is triggered before session start request is sent to Oracle servers. Listeners to this event, when triggered, will receive a JSON object with the following properties: |
|
| event.SID | SID: If session was initiated by Chat or other external application, event.SID property will contain external alphanumeric session identifier. If the session was started by the end user, this value will be undefined. | ||
| event.siteCode | siteCode: string with client Site ID | ||
2 |
SessionStarted |
This event is triggered when a Co-browse session successfully starts. Listeners to this event, when triggered, will receive a JSON object with the following properties: |
|
| event.accessCode | accessCode: string with the 6 digit access code for standalone Co-browse | ||
| event.SID | SID: string with an external alphanumeric session identifier for integrated Co-browse | ||
| event.mode | mode: string with one of two pre-defined values: "ICB" for HTML-based Co-browse mode, or "ACB" for advanced Co-browse mode | ||
| event.siteCode | siteCode: string with client Site ID | ||
3 |
SessionEnded |
This event is triggered when a co-browsing session is ended. Listeners to this event, when triggered, will receive a JSON object with the following properties: |
|
| event.reason | reason:will contain a string indicating why the session was ended. It can contain one of the pre-defined values: "USER_INITIATED": requested by the end user "USER_TIMEOUT": no agent connected within a reasonable time "NETWORK_TIMEOUT": connection was lost and could not be recovered within a reasonable time It can also contain an arbitrary
disconnect reason value if the session was stopped through the API
method |
||
| event.accessCode | accessCode: string with the 6-digit access code for standalone Co-browse. | ||
| event.SID | SID: string with an external alphanumeric session identifier for integrated Co-browse | ||
| event.siteCode | siteCode: string with client Site ID | ||
| event.agentCount | agentCount: number of currently connected agents | ||
4 |
AgentConnected |
The event is fired when a new agent connects to an ongoing session. Listeners to this event, when triggered, will receive a JSON object with the following properties: |
|
| event.name | name: agent's display name | ||
| event.id | id: unique agent ID | ||
| event.accessCode | accessCode: string with the 6-digit access code for standalone Co-browse | ||
| event.SID | SID: string with an external alphanumeric session identifier for integrated Co-browse | ||
| event.siteCode | siteCode: string with client Site ID | ||
5 |
AgentDisconnected |
The event is fired when agent disconnects from the ongoing session. Listeners to this event, when triggered, will receive a JSON object with the following properties: |
|
| event.name | name: agent's display name | ||
| event.id | id: unique agent ID | ||
| event.accessCode | accessCode: string with the 6-digit access code for standalone Co-browse | ||
| event.SID | SID: string with an external alphanumeric session identifier for integrated Co-browse | ||
| event.siteCode | siteCode: string with client Site ID | ||
6 |
StateChanged |
This event is fired on each change of the co-browsing application state which is described in Cobrowse.API.Session.getState(). This event may be used to monitor Co-browse application state and session activity. Listeners to this event, when triggered, will receive a JSON object with the following properties: |
|
| event.state | state: strings with new value of the co-browsing application state | ||
| event.previousState | previousState: strings with previous value of the co-browsing application state | ||
| event.accessCode | accessCode: string with the 6-digit access code for standalone Co-browse | ||
| event.SID | SID: string with an external alphanumeric session identifier for integrated Co-browse | ||
| event.siteCode | siteCode: string with client Site ID | ||
7 |
NavigatingAway |
Indicates that the client has clicked on a link which will open a third-party website, and which will terminate the Co-browse session. Listeners to this event, when triggered, will receive a JSON object with the following properties: |
|
| event.url | url: URL of the page to which the user will be taken if clicked on that URL | ||
| event.accessCode | accessCode: string with the 6-digit access code for standalone Co-browse | ||
| event.SID | SID: string with an external alphanumeric session identifier for integrated Co-browse | ||
| event.siteCode | siteCode: string with client Site ID |