Jump to: navigation, search
(Created target blank page For Version: PSAAS:Julie)
 
(Update with the copy of version: Public)
Line 1: Line 1:
−
<!-- Creation of the target page -->
+
= API Events =
 +
 
 +
Once you've registered your own plugin on the bus, you can subscribe and listen for published events. Below we'll quickly register a new plugin on the bus using the global bus object.
 +
 
 +
{{NoteFormat|The global bus object is a debug tool. When implementing Widgets on your own site, do not use the global bus object to register your custom plugins. Instead, see [[GWCBusExtensions|Widgets Extensions]] for more information about extending Genesys Widgets.|1}}
 +
 
 +
 
 +
<source lang='javascript'>var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');
 +
 
 +
oMyPlugin.subscribe('CoBrowse.ready', function(e){});</source>
 +
 
 +
 
 +
{|
 +
|-
 +
! Name
 +
! Description
 +
! Data
 +
|-
 +
| started
 +
| A Co-browse session has been started
 +
| n/a
 +
|-
 +
| stopped
 +
| An active Co-browse session has been stopped
 +
| n/a
 +
|-
 +
| online
 +
| Additional JS files have been loaded and a connection to the server has been established
 +
| n/a
 +
|-
 +
| ready
 +
| The CoBrowse plugin is initialized and ready on the bus
 +
| n/a
 +
|-
 +
|}
 +
<br/><br/>
 +
 
 +
[[Category:V:PSAAS:Julie]]

Revision as of 16:59, June 7, 2019

API Events

Once you've registered your own plugin on the bus, you can subscribe and listen for published events. Below we'll quickly register a new plugin on the bus using the global bus object.

Important
The global bus object is a debug tool. When implementing Widgets on your own site, do not use the global bus object to register your custom plugins. Instead, see Widgets Extensions for more information about extending Genesys Widgets.


var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');

oMyPlugin.subscribe('CoBrowse.ready', function(e){});


Name Description Data
started A Co-browse session has been started n/a
stopped An active Co-browse session has been stopped n/a
online Additional JS files have been loaded and a connection to the server has been established n/a
ready The CoBrowse plugin is initialized and ready on the bus n/a



Comments or questions about this documentation? Contact us for support!