Revision as of 21:52, October 17, 2019

API Events

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#API_Events.

@@ Line 1: / Line 1: @@
 = 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|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#API_Events.}}
-{{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:Public]]