Jump to: navigation, search
(Update with the copy of version: draft)
(Update with the copy of version: draft)
Line 1: Line 1:
 
= Configuration =
 
= Configuration =
−
== Description ==
+
{{NoteFormat|Documentation for this software has moved to a new home. Please update links and bookmarks to content hosted at https://all.docs.genesys.com/WID/Current/SDK/Co-browse-combined#Configuration.}}
−
The CoBrowse plugin has both configuration options for Genesys Widgets and configuration options for the Co-browse application itself. Listed on this page are the configuration options for the Genesys Widgets CoBrowse plugin which are defined in the global configuration object here: '_genesys.widgets.cobrowse'. Configuration objects for the Co-browse application can be set in either 'window._genesys.cobrowse' or 'window._genesys.widgets.cobrowse'. For a detailed list of configuration options for the Co-browse application, please visit the main documentation for [[GCB|Co-browse]].
 
−
== Example ==
 
−
<pre>
 
−
window._genesys.widgets.cobrowse = {
 
−
 
 
−
src: APIGEE_GCB_URL+'/cobrowse/js/gcb.min.js?apikey=APIGEE_GCB_KEY',
 
−
url: APIGEE_GCB_URL+'/cobrowse/',
 
−
apikey: 'APIGEE_GCB_KEY'
 
−
 
 
−
// Where the APIGEE_GCB_URL is the URL to the public ApiGee resource for Co-browse, and APIGEE_GCB_KEY is the ApiGee key for Co-browse.
 
−
};
 
−
</pre>
 
−
 
 
−
== Options ==
 
−
{|
 
−
|-
 
−
! Name
 
−
! Type
 
−
! Description
 
−
! Default
 
−
! Required
 
−
|-
 
−
| src
 
−
| string
 
−
| URL to the Co-browse JavaScript package. Resides on the secure access to Co-browse cluster. Must contain Co-browse apikey initialization, i.e. 
 
−
'?apikey=APIGEE_GCB_KEY'
 
−
| n/a
 
−
| Always
 
−
|-
 
−
| url
 
−
| string
 
−
| URL to the Co-browse cluster endpoint
 
−
| n/a
 
−
| Always
 
−
|-
 
−
| apikey
 
−
| string
 
−
| ApiGee key for Co-browse
 
−
| n/a
 
−
| Always
 
−
|-
 
−
|}
 
  
 
[[Category:V:PSAAS:Public]]
 
[[Category:V:PSAAS:Public]]

Revision as of 21:52, October 17, 2019

Configuration

Important
Documentation for this software has moved to a new home. Please update links and bookmarks to content hosted at https://all.docs.genesys.com/WID/Current/SDK/Co-browse-combined#Configuration.
Comments or questions about this documentation? Contact us for support!