Jump to: navigation, search
(Update with the copy of version: draft)
(Update with the copy of version: draft)
Line 3: Line 3:
  
 
{{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}}
 
{{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');
 
<source lang='javascript'>var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');
  
−
oMyPlugin.subscribe('CallBack.ready', function(e){});</source>
+
oMyPlugin.subscribe('Callback.ready', function(e){});</source>
−
 
 
  
 
{|
 
{|
Line 17: Line 15:
 
|-
 
|-
 
| opened
 
| opened
−
| The Callback widget has appeared on screen
+
| The Callback widget has appeared on screen.
−
| n/a
+
| [[CallbackMetadata|metadata]]
 
|-
 
|-
 
| ready
 
| ready
−
| Callback is initialized and ready to accept commands
+
| Callback is initialized and ready to accept commands.
 
| n/a
 
| n/a
 +
|-
 +
| started
 +
| When the user has started filling out the Callback widget form or auto pre-filled it.
 +
| [[CallbackMetadata|metadata]]
 +
|-
 +
| completed
 +
| When the Callback widget form is submitted successfully.
 +
| [[CallbackMetadata|metadata]]
 +
|-
 +
| cancelled
 +
| When the user has abandoned the interaction by closing the Callback widget before scheduling a callback.
 +
| [[CallbackMetadata|metadata]]
 
|-
 
|-
 
| closed
 
| closed
−
| The Callback widget has been removed from the screen
+
| The Callback widget has been removed from the screen.
−
| n/a
+
| [[CallbackMetadata|metadata]]
 
|-
 
|-
 
|}
 
|}
  
 
[[Category:V:PSAAS:Public]]
 
[[Category:V:PSAAS:Public]]

Revision as of 22:04, May 11, 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('Callback.ready', function(e){});
Name Description Data
opened The Callback widget has appeared on screen. metadata
ready Callback is initialized and ready to accept commands. n/a
started When the user has started filling out the Callback widget form or auto pre-filled it. metadata
completed When the Callback widget form is submitted successfully. metadata
cancelled When the user has abandoned the interaction by closing the Callback widget before scheduling a callback. metadata
closed The Callback widget has been removed from the screen. metadata
Comments or questions about this documentation? Contact us for support!