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
|
| Name
|
Type
|
Description
|
| title
|
string
|
The title
|
| iconUrl
|
string
|
The URL of the icon you want to display in the title bar of the custom toast popup.
|
| subject
|
string
|
Optional. The subject
|
| message
|
string
|
Optional. The message
|
| keyValues
|
string
|
Optional. JSON object used to fill the key value pair list. For example: {"key1" ; "value one","key2" ; "value two","key3" ; "value three"}.
|
| buttons
|
Array.<string>
|
Optional. Each character string in this array becomes a button. All buttons are displayed as buttons, not hyperlinks, in the following order: [Button 2] [Button 3] ... [Button N] [Button 1].
|
| buttonShowDismiss
|
boolean
|
Optional. If set to true, displays the Show and Dismiss buttons and pops up the current iframe if the Show button is pushed. If set to false , displays '"OK"' or custom buttons based on the parameter's buttons.
|
| autoCloseTimeout
|
object
|
Optional. If set to greater than 0, the popup is automatically closed after the specified milliseconds.
|
| sendToMyMessage
|
object
|
Optional. If set to true, sends the subject, iconUrl, title, keyValues, and message parameters to the MyMessage panel.
|
| width
|
number
|
Optional. The width of the custom toast popup, in pixels. This values takes precedence over the service-client-api.toast.width configuration option.
|
|
| Returns
|
A unique identifier
|
updateToast
| Signature
|
<static> updateToast(id, parameters) → {boolean}
|
| Description
|
Updates the specified toast.
|
| Parameters
|
| Name
|
Type
|
Description
|
| id
|
string
|
The identifier of the toast to update. The identifier is returned by the popupToast method.
|
| parameters
|
object
|
| Name
|
Type
|
Description
|
| title
|
string
|
The title
|
| iconURL
|
string
|
The URL of the icon you want to display in the title bar of the custom toast popup.
|
| subject
|
string
|
Optional. The subject.
|
| message
|
string
|
Optional. The message.
|
| keyValues
|
object
|
Optional. JSON object used to fill the key value pair list. For example: {"key1" : "value one","key2" : "value two","key3" : "value three"}.
|
| buttons
|
Array.<string>
|
Each character string in this array becomes a button. All buttons are displayed as buttons, not hyperlinks, in the following order: [Button 2] [Button 3] ... [Button N] [Button 1].
|
| buttonShowDismiss
|
boolean
|
If set to true, displays Show and Dismiss buttons and pops up the current iframe if the Show button is pushed. If set to false, displays '"OK"' or custom buttons based on the parameter's buttons.
|
|
|
| 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
|
| Name
|
Type
|
Description
|
| id
|
string
|
The identifier of the toast to close. The identifier is returned by the popupToast method.
|
|
| Returns
|
true if the toast has been updated; false if the toast identifier has not been found.
|
isFrameLeading
| Signature
|
<static> isFrameLeading(succeeded, failed) → {boolean}
|
| Description
|
Find out if the browser tab is leading.
|
| Parameters
|
| Name
|
Type
|
Description
|
| succeeded
|
string
|
The callback function to use if the operation succeeded.
|
| failed
|
string
|
The callback function to use if the operation failed.
|
|
| Returns
|
true if the browser tab is the leader.
|
isFrameFollowing
| Signature
|
<static> isFrameFollowing(succeeded, failed) → {boolean}
|
| Description
|
Find out if the browser tab is following.
|
| Parameters
|
| Name
|
Type
|
Description
|
| succeeded
|
string
|
The callback function to use if the operation succeeded.
|
| failed
|
string
|
The callback function to use if the operation failed.
|
|
| Returns
|
true if this browser tab is following.
|
isFrameNegotiating
| Signature
|
<static> isFrameNegotiating(succeeded, failed) → {boolean}
|
| Description
|
Find out if there is an election in progress and the browser tab state is not yet set to leading or following (the tab is "negotiating.")
|
| Parameters
|
| Name
|
Type
|
Description
|
| succeeded
|
string
|
The callback function to use if the operation succeeded.
|
| failed
|
string
|
The callback function to use if the operation failed.
|
|
| Returns
|
true if the tab is negotiating.
|
isFrameLeadingOrNegotiating
| Signature
|
<static> isFrameLeadingOrNegotiating(succeeded, failed) → {boolean}
|
| Description
|
Find out if the browser tab is leading or there is an election in progress and the tab state is not yet set to leading or following (the tab is "negotiating.").
|
| Parameters
|
| Name
|
Type
|
Description
|
| succeeded
|
string
|
The callback function to use if the operation succeeded.
|
| failed
|
string
|
The callback function to use if the operation failed.
|
|
| Returns
|
true if the browser tab is leading or negotiating.
|
isLastActiveFrame
| Signature
|
<static> isLastActiveFrame(succeeded, failed) → {boolean}
|
| Description
|
Find out if this is the last active browser tab.
|
| Parameters
|
| Name
|
Type
|
Description
|
| succeeded
|
string
|
The callback function to use if the operation succeeded.
|
| failed
|
string
|
The callback function to use if the operation failed.
|
|
| Returns
|
true if this is the last active browser tab.
|
