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('GWE.open');

configure

Modify configuration options for GWE. See configuration page for GWE.

Example

oMyPlugin.command('GWE.configure', {

	httpEndpoint: 'http://localhost:8080/foo/bar',
	httpsEndpoint: 'https://localhost:8080/foo/bart'

}).done(function(e){

	// GWE configured successfully

}).fail(function(e){

	// GWE wasn't configured properly
});

Options

Option	Type	Description
httpEndpoint	string	URL/Path to the GWE server over standard HTTP
httpsEndpoint	string	URL/Path to the GWE server over secure HTTPS

Resolutions

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