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('SendMessage.ready', function(e){});

Name	Description	Data
ready	The Send Message is initialized and ready to accept commands	n/a
opened	The Send Message widget has appeared on screen	Metadata
started	The Send Message has successfully started.	Metadata
submitted	The user has submitted the form.	Metadata
completed	The Send Message has successfully sent the message.	Metadata
cancelled	The Send Message has been closed before sending the message.	Metadata
minimized	The Send Message widget has been changed to a minimized state	n/a
unminimized	The Send Message widget has been restored from a minimized state to the standard view	n/a
closed	The Send Message widget has been removed from the screen	Metadata