Jump to: navigation, search
(Update with the copy of version: draft)
(Update with the copy of version: draft)
Line 4: Line 4:
  
 
{{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}}
 
{{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');
 
<source lang='javascript'>var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');
  
−
oMyPlugin.command('StatsService.getUserAgent');</source>
+
oMyPlugin.command('StatsService.getStats');</source>
  
 
== configure ==
 
== configure ==
Line 129: Line 128:
 
| When no EWT dataURL provided
 
| When no EWT dataURL provided
 
| 'Invalid EWT configuration'
 
| 'Invalid EWT configuration'
−
|-
 
−
|}
 
−
== getUserAgent ==
 
−
Receive User Agent data from the browser
 
−
<br /><br />
 
−
=== Example ===
 
−
<source lang='javascript'>
 
−
oMyPlugin.command('StatsService.getUserAgent').done(function(e){
 
−
 
−
// StatsService got user agent data successfully
 
−
// e == Object of User agent data
 
−
 
−
}).fail(function(e){
 
−
 
−
// StatsService failed to get user agent data
 
−
});
 
−
</source>
 
−
 
−
<br />
 
−
=== Resolutions ===
 
−
{|
 
−
|-
 
−
! Status
 
−
! When
 
−
! Returns
 
−
|-
 
−
| resolved
 
−
| Always
 
−
| UAParser object with functions to find browser ( .getBrowser() ), OS  ( .getOS() ), mobile/web detection ( .mobileCheck() )
 
 
|-
 
|-
 
|}
 
|}
  
 
[[Category:V:PSAAS:Public]]
 
[[Category:V:PSAAS:Public]]

Revision as of 22:09, May 11, 2018

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.

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.command('StatsService.getStats');

configure

Internal use only. The main App plugin shares configuration settings to widgets using each widget’s configure command. The configure command can only be called once at startup. Calling configure again after startup may result in unpredictable behavior.

Example

oMyPlugin.command('StatsService.configure', {

	ewt:{

		apikey: '12345',
		dataURL: 'http://localhost:8080/foo/bar'
	},
	ajaxTimeout: 10000

}).done(function(e){

	// StatsService configured successfully

}).fail(function(e){

	// StatsService failed to configure
});


Options

Option Type Description
ewt.apikey string API access token. Please contact your Genesys representative to obtain your API access token.
ewt.dataURL URL String URL of GMS server
ajaxTimeout number Number of milliseconds to wait before AJAX timeout.


Resolutions

Status When Returns
resolved When configuration options are provided and set n/a
rejected When no configuration options are provided 'Invalid configuration'

getStats

Make a request to Genesys Stats server to fetch EWT details.

Example

oMyPlugin.command('StatsService.getStats', {

	group: 'EWT',
	vqname: 'chat_ewt_test_eservices'

}).done(function(e){

	// StatsService got stats successfully

}).fail(function(e){

	// StatsService failed to get stats
});


Options

Option Type Description
group string Mention specific group name you would like to request like EWT, etc.
vqname string Mention virtual queue name for EWT.


Resolutions

Status When Returns
resolved When server returns EWT data (AJAX Response Object)
rejected When server fail request fails 'EWT request failed due to unknown reason'
rejected When no EWT dataURL provided 'Invalid EWT configuration'
Comments or questions about this documentation? Contact us for support!