WID/Current/SDK/GWCBusAPIOverview - Revision history

Xavier: Published

2023-02-06T14:41:08Z

Published

Chrissy.forrest@genesys.com: Published

2021-02-03T20:56:02Z

Published

Chrissyforrest: Published

2020-10-27T18:49:38Z

Published

Chrissyforrest: Published

2020-10-22T21:29:18Z

Published

Chrissyforrest: Published

2020-07-30T20:42:05Z

Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

2020-07-25T02:39:52Z

Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"

2020-07-15T11:50:56Z

Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

Chrissyforrest: Published

2020-07-10T19:05:57Z

Published

Chrissyforrest: Published

2020-06-01T18:31:01Z

Published

Chrissyforrest: Published

2020-05-29T19:15:08Z

Published

Show changes

@@ Line 140: / Line 140: @@
 * Any number of plugins can be included in this object.
 * Only works when using the lazy-loading method of initializing Widgets.
-*Not intended to be used to load different versions of Genesys Widgets plugins.}}
+*Not intended to be used to load different versions of Genesys Widgets plugins.
 {{!}}}

@@ Line 191: / Line 191: @@
 When the plugin loads successfully, done() will be triggered.
 When the plugin fails to load, fail() will be triggered.
 ===CXBus.registerPlugin===
 Registers a new plugin namespace on the bus and returns a plugin interface object. You will use the plugin interface object to publish, subscribe, call commands, and perform other CXBus functions.

@@ Line 49: / Line 49: @@
 </source>
 ===Extensions===
-You can define your own plugins/widgets that interface with Genesys Widgets. For more information, please see {{Link-SomewhereInThisVersion|manual=SDK|topic=GWCBusExtensions|display text=Genesys Widgets Extensions}}.
+You can define your own plugins/widgets that interface with Genesys Widgets. For more information, please see {{Link-SomewhereInThisVersion|manual=SDK|topic=GWCBusExtensions|display text=Genesys Widgets extensions}}.
 |Status=No
 }}{{Section

@@ Line 49: / Line 49: @@
 </source>
 ===Extensions===
-You can define your own plugins/widgets that interface with Genesys Widgets. For more information, please see {{Link-SomewhereInThisVersion|manual=SDK|topic=GWCBusExtensions|display text=Extensions}}.
+You can define your own plugins/widgets that interface with Genesys Widgets. For more information, please see {{Link-SomewhereInThisVersion|manual=SDK|topic=GWCBusExtensions|display text=Genesys Widgets Extensions}}.
 |Status=No
 }}{{Section

@@ Line 17: / Line 17: @@
 Publications and subscriptions are loosely bound so that you can publish and subscribe to any event without that event explicitly being available. This allows for plugins to lazy load into the bus or provide conditional logic in your plugins so they can wait for other plugins to be available.
-CXBus events and commands are executed asynchronously using deferred methods and promises. This allows for:
+CXBus events and commands are executed asynchronously using deferred methods and promises. This allows for better performance and standardized Pass/Fail handling for all commands. Command promises are not resolved until the command is finished, including any nested asynchronous commands that command may invoke. This gives you assurance that the command completed successfully and the timing of your follow-up action will occur at the right time. As for permissions, CXBus provides metadata in every command call including which plugin called the command and at what time. This allows for plugins to selectively allow/deny invocation of commands.
 You can use three methods to access the Bus:

@@ Line 5: / Line 5: @@
 |Context=Learn about the bus that all widgets components are built on.
 |ComingSoon=No
-|Platform=GenesysEngage-onpremises
+|Platform=GenesysEngage-cloud
 |Role=Developer
 |Section={{Section

@@ Line 6: / Line 6: @@
 |ComingSoon=No
 |Platform=PureEngage
-|Prereq=
+|Role=Developer
 |Section={{Section
 |sectionHeading=Overview
 |anchor=Overview
 |alignment=Vertical
 |structuredtext=Genesys Widgets is built on top of the CXBus messaging bus. CXBus uses the {{#Widget:ExtLink|link=https://en.wikipedia.org/wiki/Publish–subscribe_pattern|displaytext=publish-subscribe}} model to facilitate communication between the Widgets components, all of which are ''plugins'' that can both ''publish'' events on the bus and ''subscribe'' to the events they are interested in.
@@ Line 57: / Line 55: @@
 ===Extensions===
 You can define your own plugins/widgets that interface with Genesys Widgets. For more information, please see {{Link-SomewhereInThisVersion|manual=SDK|topic=GWCBusExtensions|display text=Extensions}}.
 |Status=No
 }}{{Section
@@ Line 64: / Line 60: @@
 |anchor=CXBusReference
 |alignment=Vertical
 |structuredtext=The CXBus instance is exposed globally (window.CXBus) and has several methods available:
@@ Line 224: / Line 218: @@
 If the namespace is not already taken, it will return a CXBus plugin interface object configured with the selected namespace.
 If the namespace is already taken, it will return false.
 |Status=No
 }}{{Section
@@ Line 231: / Line 223: @@
 |anchor=CXBusPluginInterfaceReference
 |alignment=Vertical
 |structuredtext=When you register a plugin using CXBus.registerPlugin(), it returns a CXBus Plugin Interface Object. This object contains many methods that allow you to interact with other plugins on the bus.
@@ Line 615: / Line 605: @@
 ====Returns====
 Returns nothing.
 |Status=No
 }}
 }}

@@ Line 3: / Line 3: @@
 |DisplayName=Widgets Bus API overview
 |TocName=Widgets Bus API overview
-|Context=Learn about the bus that all of the other Widgets components are built on.
+|Context=Learn about the bus that all widgets components are built on.
 |ComingSoon=No
 |Platform=PureEngage
@@ Line 9: / Line 9: @@
 |Section={{Section
 |sectionHeading=Overview
-|anchor=
+|anchor=Overview
 |alignment=Vertical
 |Media=
@@ Line 62: / Line 62: @@
 }}{{Section
 |sectionHeading=CXBus Reference
-|anchor=
+|anchor=CXBusReference
 |alignment=Vertical
 |Media=
@@ Line 68: / Line 68: @@
 |structuredtext=The CXBus instance is exposed globally (window.CXBus) and has several methods available:
-* CXBus.command
+*CXBus.command
-* CXBus.configure
+*CXBus.configure
-* CXBus.loadFile
+*CXBus.loadFile
-* CXBus.loadPlugin
+*CXBus.loadPlugin
-* CXBus.registerPlugin
+*CXBus.registerPlugin
 ===CXBus.command===
@@ Line 229: / Line 229: @@
 }}{{Section
 |sectionHeading=CXBus Plugin Interface Reference
-|anchor=
+|anchor=CXBusPluginInterfaceReference
 |alignment=Vertical
 |Media=
@@ Line 573: / Line 573: @@
+{
-	"WebChatService.agentConnected":["CoBrowse","CallUs","ChatDeflection","WebChat","GWE"],
+	"WebChatService.agentConnected":["WebChat"],
-	"WebChatService.agentDisconnected":["CoBrowse","CallUs","WebChat"],
+	"WebChatService.agentDisconnected":["WebChat"],
-	"WebChatService.ready":["ChatDeflection"],
+	"WebChatService.ready":[],
-	"WebChatService.started":["ChatDeflection","WebChat","GWE"],
+	"WebChatService.started":["WebChat"],
-	"WebChatService.restored":["ChatDeflection","WebChat"],
+	"WebChatService.restored":["WebChat"],
-	"WebChatService.clientDisconnected":["ChatDeflection"],
+	"WebChatService.clientDisconnected":[],
-	"WebChatService.clientConnected":["ChatDeflection","GWE"],
+	"WebChatService.clientConnected":[],
-	"WebChatService.messageReceived":["ChatDeflection","WebChat"],
+	"WebChatService.messageReceived":["WebChat"],
-	"WebChatService.error":["WebChat","GWE"],
+	"WebChatService.error":["WebChat"],
 	"WebChatService.restoreTimeout":["WebChat"],
 	"WebChatService.restoreFailed":["WebChat"],
-	"WebChatService.ended":["WebChat","GWE"],
+	"WebChatService.ended":["WebChat"],
 	"WebChatService.agentTypingStarted":["WebChat"],
 	"WebChatService.agentTypingStopped":["WebChat"],
@@ Line 590: / Line 590: @@
 	"WebChatService.chatServerWentOffline":["WebChat"],
 	"WebChatService.chatServerBackOnline":["WebChat"],
-	"WebChatService.disconnected":["WebChat","GWE"],
+	"WebChatService.disconnected":["WebChat"],
 	"WebChatService.reconnected":["WebChat"]
+}

WID/Current/SDK/GWCBusAPIOverview - Revision history

Xavier: Published

Chrissy.forrest@genesys.com: Published

Chrissyforrest: Published

Chrissyforrest: Published

Chrissyforrest: Published

WikiSysop: Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

Chrissyforrest: Published

Chrissyforrest: Published

Chrissyforrest: Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"