(Update with the copy of version: draft) |
(Update with the copy of version: draft) |
||
Line 15: | Line 15: | ||
|- | |- | ||
| ready | | ready | ||
− | | Sidebar is initialized and ready to accept commands | + | | Sidebar is initialized and ready to accept commands. |
| n/a | | n/a | ||
|- | |- | ||
Line 23: | Line 23: | ||
|- | |- | ||
| closed | | closed | ||
− | | Sidebar widget has been removed from the screen | + | | Sidebar widget has been removed from the screen. |
| n/a | | n/a | ||
|- | |- | ||
| expanded | | expanded | ||
− | | Sidebar widget has expanded showing | + | | Sidebar widget has expanded, showing channel icon and name. |
| n/a | | n/a | ||
|- | |- | ||
| contracted | | contracted | ||
− | | Sidebar widget has | + | | Sidebar widget has contracted back, showing channel icons only. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
| n/a | | n/a | ||
|- | |- |
Revision as of 17:12, July 27, 2018
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('SideBar.ready', function(e){ /* sample code */ });
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 channel icon and name. | n/a |
contracted | Sidebar widget has contracted back, showing channel icons only. | n/a |
Comments or questions about this documentation? Contact us for support!