Jump to: navigation, search

API Events

Once you've registered your own plugin on the bus, you can subscribe and listen for published events. 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');

oMyPlugin.subscribe('KnowledgeCenterService.ready', function(e){ /* sample code */ };

Name Description Data
ready The KnowledgeCenterService widget is loaded. n/a
online The KnowledgeCenterService widget is configured and ready to execute requests. n/a
sessionChanged The session started or one of its parameters had changed. {sessionId: (string), language: (string), media: (string), customer: (string)}
noResultsFound Search did not return results or results are empty {query: (string), language: (string), media: (string), knowledgebases: (list of string), sessionId: (string), tenantId: (string)}
documentOpened Full document content has been requested {language: (string), knowledgebase: (string), sessionId: (string), tenantId: (string), documentId: (string), document: (object)}
searched Query has been searched and results provided {query: (string), language: (string), media: (string), knowledgebases: (list of strings), sessionId: (string), documents: (list of objects)}
suggested Autocomplete queries have been suggested {language: (string), sessionId: (string), tenantId: (string), query: (string), categories: (list of objects), filters: (object), media: (string), knowledgebases: (list of strings)}
voted Relevancy feedback has been provided for the search result {language: (string), sessionId: (string), tenantId: (string), relevant: (boolean), knowledgebase: (string), documentId: (string)}

This page was last edited on May 11, 2018, at 12:35.
blog comments powered by Disqus