Jump to: navigation, search
(Update with the copy of version: draft)
(Automated save: adding PEC_Migrated template.)
 
(2 intermediate revisions by 2 users 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('SideBar.ready', function(e){ /* sample code */ });</source>
 
−
 
−
{|
 
−
|-
 
−
! Name
 
−
! Description
 
−
! Data
 
−
|-
 
−
| ready
 
−
| Sidebar is initialized and ready to accept commands
 
−
| n/a
 
−
|-
 
−
| opened
 
−
| Sidebar widget has appeared on screen. For desktop it is displayed on the sides of the screen and in mobiles at the bottom corner as a button.
 
−
| n/a
 
−
|-
 
−
| closed
 
−
| Sidebar widget has been removed from the screen
 
−
| n/a
 
−
|-
 
−
| expanded
 
−
| Sidebar widget has expanded showing all channel details in desktops.
 
−
| n/a
 
−
|-
 
−
| contracted
 
−
| Sidebar widget has slid back to initial state showing minimal channel details in desktops.
 
−
| n/a
 
−
|-
 
−
| mobile.expanded
 
−
| Sidebar widget has expanded to full screen in mobiles, showing all channel details.
 
−
| n/a
 
−
|-
 
−
| mobile.contracted
 
−
| Sidebar widget is minimized back to initial state in mobiles.
 
−
| n/a
 
−
|-
 
−
|}
 
−
<br/><br/>
 
  
 +
{{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/SideBar-combined#API_Events.}}
 
[[Category:V:PSAAS:Public]]
 
[[Category:V:PSAAS:Public]]

Latest revision as of 23:17, 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/SideBar-combined#API_Events.
This page was last edited on June 21, 2020, at 23:17.
Comments or questions about this documentation? Contact us for support!