|
|
| Line 1: |
Line 1: |
| | = API Events = | | = 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.
| + | {{NoteFormat|Documentation for this software has moved to a new home. Please update links and bookmarks to content hosted at https://all.docs.genesys.com/WID/Current/SDK/Engagement-combined#API_Events.}} |
| − | | |
| − | {{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 [[Documentation:PSAAS:Administrator:GWCBusExtensions|Widgets Extensions]] for more information about extending Genesys Widgets.|1}} | |
| − | | |
| − | | |
| − | <source lang='javascript'>var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');
| |
| − | | |
| − | oMyPlugin.subscribe('KnowledgeCenterService.ready', function(e){ /* sample code */ };</source>
| |
| − | | |
| − | | |
| − | {|
| |
| − | |-
| |
| − | ! 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)}
| |
| − | |-
| |
| − | |}
| |
| − | <br/><br/>
| |
| | | | |
| | [[Category:V:PSAAS:Public]] | | [[Category:V:PSAAS:Public]] |
