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	n/a
opened	The Offers Widget has opened	Metadata
hover	When the user first hovers over the offer	Metadata
CTA	When the user clicks on the element in an offer which triggers CTA	Metadata
timeout	The Offer has timed out	Metadata
dismissed	When the user closes the offer by clicking the close button	Metadata
videoReady	The video player has initialized and the video is ready to play in offer	n/a
videoStarted	The video has started playing in offer	n/a
videoPlaying	The video player plays the video in offer	n/a
videoPaused	The video has paused	n/a
videoEnded	The video has ended	n/a
videoPlayed	When the video is first played (manually or auto-played)	Metadata
videoReady	The video player has initialized and the video is ready to play in offer	n/a
videoStarted	The video has started playing in offer	n/a
videoPlaying	The video player plays the video in offer	n/a
videoPaused	The video has paused	n/a
videoEnded	The video has ended	n/a
closed	The Offers Widget has closed	Metadata