Jump to: navigation, search
(Update with the copy of version: draft)
(Automated save: adding PEC_Migrated template.)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
= API Events =
 
= 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}}
+
{{Template:PEC_Migrated}}
  
−
<source lang='javascript'>var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');
 
  
−
oMyPlugin.subscribe('Offers.ready', function(e){ /* sample code */ });</source>
+
{{NoteFormat|Documentation for this software has moved to a new home. Please update links and bookmarks to content hosted at https://all.docs.genesys.com/WID/Current/SDK/Offers-combined#API_Events.}}
−
 
 
−
 
 
−
{|
 
−
|-
 
−
! 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:Public]]
 
[[Category:V:PSAAS:Public]]

Latest revision as of 23:03, June 21, 2020

API Events

Important
This content may not be the latest Genesys Engage cloud content. To find the latest content, go to Genesys Engage cloud for Administrators.


Important
Documentation for this software has moved to a new home. Please update links and bookmarks to content hosted at https://all.docs.genesys.com/WID/Current/SDK/Offers-combined#API_Events.
This page was last edited on June 21, 2020, at 23:03.
Comments or questions about this documentation? Contact us for support!