Difference between revisions of "PEC-Developer/Current/SCAPI/SystemNamespace"
From Genesys Documentation
m (Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2") |
m (Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2") |
||
Line 5: | Line 5: | ||
|Context=Learn about the System namespace methods in the Service Client API. | |Context=Learn about the System namespace methods in the Service Client API. | ||
|ComingSoon=No | |ComingSoon=No | ||
− | |Platform=GenesysEngage- | + | |Platform=GenesysEngage-cloud |
|Prereq= | |Prereq= | ||
|Section={{Section | |Section={{Section |
Revision as of 02:34, July 25, 2020
Contents
Learn about the System namespace methods in the Service Client API.
Methods
The System namespace includes the following methods:
getAllowedServices
Signature | <static> getAllowedServices() → {Array.<string>} |
---|---|
Description | Gets the list of allowed services, as determined by the security configuration for Agent Desktop. If the domain of the web application that calls this method isn't listed in the service-client-api.accepted-web-content-origins option, then this method fails. Contact your Genesys representative for details about this configuration. |
Returns | Array.<string> |
triggerActivity
Signature | <static> triggerActivity() |
---|---|
Description | Triggers a fake activity to prevent the inactivity timer from closing the agent session. |
popupToast
Signature | <static> popupToast(parameters) → {string} | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Description | Pops up a new custom toast. | ||||||||||||||||||||||||||||||
Parameters |
| ||||||||||||||||||||||||||||||
Returns | A unique identifier |
updateToast
Signature | <static> updateToast(id, parameters) → {boolean} | |||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Description | Updates the specified toast. | |||||||||||||||||||||||||||||||||
Parameters |
| |||||||||||||||||||||||||||||||||
Returns | true if the toast has been updated; false if the toast identifier has not been found. |
closeToast
Signature | <static> closeToast(id) → {boolean} | ||||||
---|---|---|---|---|---|---|---|
Description | Closes the specified toast. | ||||||
Parameters |
| ||||||
Returns | true if the toast has been updated; false if the toast identifier has not been found. |
Comments or questions about this documentation? Contact us for support!