Jump to: navigation, search
(Update with the copy of version: 8.5.0)
(Automated save: adding PEC_Migrated template.)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
 
= API Commands =
 
= API Commands =
  
−
Once you've registered your own plugin on the bus, you can call commands on other registered plugins. Below we'll quickly register a new plugin on the bus using the global bus object.
+
{{Template:PEC_Migrated}}
  
−
{{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');
+
{{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/Console-combined#API_Commands.}}
−
 
 
−
oMyPlugin.command('Console.open');</source>
 
−
 
 
−
== open ==
 
−
Opens the Console UI.
 
−
<br /><br />
 
−
=== Example ===
 
−
<source lang='javascript'>
 
−
oMyPlugin.command('Console.open').done(function(e){
 
−
 
 
−
// Console opened successfully
 
−
 
 
−
}).fail(function(e){
 
−
 
 
−
// Console failed to open
 
−
});
 
−
</source>
 
−
 
 
−
<br />
 
−
=== Resolutions ===
 
−
{|
 
−
|-
 
−
! Status
 
−
! When
 
−
! Returns
 
−
|-
 
−
| resolved
 
−
| When Console is successfully opened
 
−
| n/a
 
−
|-
 
−
| rejected
 
−
| When Console is already open
 
−
| 'Already opened'
 
−
|-
 
−
|}
 
−
== close ==
 
−
Closes the Console UI.
 
−
<br /><br />
 
−
=== Example ===
 
−
<source lang='javascript'>
 
−
oMyPlugin.command('Console.close').done(function(e){
 
−
 
 
−
// Console closed successfully
 
−
 
 
−
}).fail(function(e){
 
−
 
 
−
// Console failed to close
 
−
});
 
−
</source>
 
−
 
 
−
<br />
 
−
=== Resolutions ===
 
−
{|
 
−
|-
 
−
! Status
 
−
! When
 
−
! Returns
 
−
|-
 
−
| resolved
 
−
| When Console successfully closed
 
−
| n/a
 
−
|-
 
−
| rejected
 
−
| When Console is already closed
 
−
| 'Already closed'
 
−
|-
 
−
|}
 
−
== configure ==
 
−
Modify configuration options for Console. See configuration page for Console
 
−
<br /><br />
 
−
=== Example ===
 
−
<source lang='javascript'>
 
−
oMyPlugin.command('Console.configure', {
 
−
 
 
−
open: false
 
−
 
 
−
}).done(function(e){
 
−
 
 
−
// Console configured successfully
 
−
 
 
−
}).fail(function(e){
 
−
 
 
−
// Console failed to configure
 
−
});
 
−
</source>
 
−
 
 
−
<br />
 
−
=== Options ===
 
−
{|
 
−
|-
 
−
! Option
 
−
! Type
 
−
! Description
 
−
|-
 
−
| open
 
−
| boolean
 
−
| If setting is open: true, the console will automatically be open when widgets is launched and the console is ready.
 
−
|-
 
−
|}
 
−
<br />
 
−
=== Resolutions ===
 
−
{|
 
−
|-
 
−
! Status
 
−
! When
 
−
! Returns
 
−
|-
 
−
| resolved
 
−
| When Console configuration is provided
 
−
| n/a
 
−
|-
 
−
| rejected
 
−
| When no configuration provided
 
−
| 'Invalid Configuration'
 
−
|-
 
−
|}
 
−
 
 
 
[[Category:V:PSAAS:Public]]
 
[[Category:V:PSAAS:Public]]

Latest revision as of 22:42, June 21, 2020

API Commands

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/Console-combined#API_Commands.
This page was last edited on June 21, 2020, at 22:42.
Comments or questions about this documentation? Contact us for support!