Citrix Workspace app for Chrome HDX SDK
Events
onConnection
To receive various states during the connection from client to server.
Type
Object
Properties
| Name | Type | Description |
|---|---|---|
state |
String | The various connection states are connecting (raised when connection starts before displaying connection dialog), connected (raised when connection is complete and when server and client start exchanging data), and sessionReady (raised when session is fully initialized, launched, and ready for user interaction). |
Example
Sample event object generated for onConnection event:
{
"id":"<session id>",
"type" : "onConnection",
"data":{
"state" : "connecting" // Event is triggered 3 times with different states mentioned above.
}
}
<!--NeedCopy-->
onConnectionClosed
Raised when the connection with the server is closed.
Example
Sample event object generated for onConnectionClosed event:
{
"id": "<session id>",
"type": "onConnectionClosed",
}
<!--NeedCopy-->
onError
Raised on occurrence of any error in Citrix Workspace app for Chrome.
Type
Object
Properties
| Name | Type | Description |
|---|---|---|
id |
String | String ID defined in .js. For example, en.js is for English, ko.js is for Korean. ID remains the same for all locales supported. |
message |
String | Localized error message for the key. Customer can provide a custom string in the language file to get a meaningful error in the context of the deployment. |
Example
Sample event object generated for onError event:
{
"id":"<session id>",
"type" : "onError",
"data":{
"id":"<key_in_locale_file>",
"message" : "<value_for_the_key_in_locale_file>"
}
}
<!--NeedCopy-->
onURLRedirection
Raised when URL redirection is configured on the server and when any URL is passed to the Workspace app for Chrome engine to process. The message would contain the URL that is redirected to the client.
Type
Object
Properties
| Name | Type | Description |
|---|---|---|
url |
String | The value of the URL would contain the URL that is redirected to the client |
Example
Sample event object generated for onURLRedirection event:
{
"id":"<session id>",
"type" : "onURLRedirection",
"data":{
"url" : "<url_received_to_redirect>"
}
}
<!--NeedCopy-->
Events
Copied!
Failed!