Jump to: navigation, search
(Created target blank page For Version: PSAAS:Public)
 
(Update with the copy of version: draft)
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('Offers.ready', function(e){ /* sample code */ });</source>
 +
 
 +
{|
 +
|-
 +
! Name
 +
! Description
 +
! Data
 +
|-
 +
| ready
 +
| Offers is initialized and ready to accept commands
 +
|
 +
|-
 +
| opened
 +
| The Offers Widget has been opened
 +
|
 +
|-
 +
| closed
 +
| The Offers Widget has been closed
 +
|
 +
|-
 +
|}
 +
 
 +
[[Category:V:PSAAS:Public]]

Revision as of 19:30, March 8, 2018

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('Offers.ready', function(e){ /* sample code */ });
Name Description Data
ready Offers is initialized and ready to accept commands
opened The Offers Widget has been opened
closed The Offers Widget has been closed
Comments or questions about this documentation? Contact us for support!