Jump to: navigation, search
(Created target blank page For Version: PSAAS:Julie)
 
(Update with the copy of version: Public)
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
 +
| n/a
 +
|-
 +
| opened
 +
| The Offers Widget has opened
 +
| [[OffersMetadata|Metadata]]
 +
|-
 +
| hover
 +
| When the user first hovers over the offer
 +
| [[OffersMetadata|Metadata]]
 +
|-
 +
| CTA
 +
| When the user clicks on the element in an offer which triggers CTA
 +
| [[OffersMetadata|Metadata]]
 +
|-
 +
| timeout
 +
| The Offer has timed out
 +
| [[OffersMetadata|Metadata]]
 +
|-
 +
| dismissed
 +
| When the user closes the offer by clicking the close button
 +
| [[OffersMetadata|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)
 +
| [[OffersMetadata|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
 +
| [[OffersMetadata|Metadata]]
 +
|-
 +
|}
 +
<br/><br/>
 +
 
 +
[[Category:V:PSAAS:Julie]]

Revision as of 16:59, June 7, 2019

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



Comments or questions about this documentation? Contact us for support!