Maintenance Notice - PDF Generation
Dynamic PDF generation for web-based content is temporarily unavailable. This maintenance affects dynamic PDF files that are generated from either the HTML-based page or manual that you are viewing. Links that normally allow this functionality have been hidden, and will reappear as soon as the feature is restored.

Note: Access to static files, including PDF files that are not dynamically generated from our web-based content, is unaffected.

Jump to: navigation, search

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.

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');



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.


Opens the Offers Widget and renders an offer based on the JSON options provided. If no options are provided, it renders the default offer defined in the configuration.


oMyPlugin.command('', {
	title:'Offer Title',
	headline:'This is the headline',
	body:'This is the body',
	button:'Accept Offer',
		command: '',
		commandOptions: {'proactive': true,'userData': {'category': 'shoes'}},
		url: '',
		target: '_blank'
	timeout: 11000,
	autoplay: true,
		autoplay: false,
		loop: true
		'.cx-body': {
			'background-color': '#FFFFFF',
			'color': '#008000'


Option Type Description Accepted Values Introduced / Updated
mode string Widget display type overlay, toaster
modal boolean Smokescreen support option for overlay n/a
layout string Additional layout options for overlay leftText, rightText, minimal, stacked
title string String for widget title n/a
headline string String for Offer title header n/a
body string String for offer body text n/a
button string String for CTA button text n/a
cta object An object containing the URL and/or CXBus command for call to action n/a
cta.command string A CXBus command to execute n/a
cta.commandOptions object Options related to CXBUs command n/a
cta.url string - URL URL string for call to action.

Note: The URL must be properly defined with the complete Protocol URL Address. For example,

n/a string String to specify where to open the cta URL _blank, _parent, _self, _top, framename
image string - URL Image URL string n/a
video string - URL Video URL string, YouTube/Vimeo n/a
autoplay boolean Autoplay option for Video true, false
videoOptions object An object containing player-specific configuration options n/a
timeout number Timeout integer in ms n/a
countdownText string String for offer countdown text n/a
position object An object containing the properties for positioning the offers window left, right, top, bottom
styles object An object containing a custom CSS declarations n/a


Status When Returns
resolved When configuration options are provided, valid and set n/a
rejected When no valid configuration options are provided 'Invalid configuration; detailed CXBus warning'


Closes an open offers widget.




Status When Returns
resolved When the widget is closed n/a
rejected When the widget is already closed 'CXBus warning.'
This page was last edited on April 26, 2019, at 12:52.


Comment on this article:

blog comments powered by Disqus