Citrix Workspace app for HTML5 HDX SDK
Global
Type Definitions
connectionParams
Configuration options to create the session.
Type
Object
Properties:
Example
connectionParams full example
{
"launchType" : "embed",
"container" : {
"id" : "<iframe id>",
"type" : "iframe"
},
"bounds" :{
"autoresize":false,
"width": "800",
"height":"600"
},
"closeOptions" : {
"type" : "redirecturl",
"value": "<url to redirect>",
"showDisconnectAlert" : true //false won't prompt when the session is about to disconnect due to the actions like close/reload of the tab.
},
"preferredLang" : "ja", //Setting to Japanese
"preferences" : {
"ui" : {
'toolbar' : {
"menubar":true, //false - hides the toolbar
"clipboard":true, //false - hides the clipboard button from toolbar
"fileTransfer":true, //false - hides the file upload and download buttons from toolbar
"about":true, //false - hides the about button from toolbar
"lock":true, //false - hides the ctrl+alt+del button from toolbar
"disconnect":true, //false - hides the disconnect button from toolbar
"logoff":true, // false - hides the logoff button from toolbar
"fullscreen":true, //false - hides the fullscreen button from toolbar
"keyboard":true, //false - hides the keyboard button from toolbar, this button appears only in touch devices
"multitouch":true, //false - hides the multitouch button from toolbar, this button appears only in touch devices
"switchApp":true, //false - hides the switchApp button from toolbar, this button appears only for apps session
"preferences":true, //false - hides the preferences button from toolbar
"gestureGuide":true //false - hides the gestureGuide button from toolbar, this button appears only in touch devices
},
"hide":{
"urlredirection" : false, //true - hides the urlredirection dialog shown by HTML5 Engine
"error" : false, //true - hides the error dialog shown by HTML5 Engine
"ftu" : false //true - hides the FTU(first time user dialog) shown by HTML5 Engine
},
"appSwitcher": {
"showTaskbar": true, //false - disables the desktop appSwitcher/taskbar seen at the bottom
"autoHide": false, //true - selects the Auto Hide checkbox present in the context menu of desktop appSwitcher/taskbar at the bottom
"showIconsOnly": false //true - selects the Show Icons only checkbox present in the context menu of desktop appSwitcher/taskbar at the bottom
}
}
}
}
<!--NeedCopy-->
eventListener(event)
Listener to handle the events.
Parameters
| Name | Type | Description |
|---|---|---|
event |
Object | Object as appropriate to the eventType registered. |
Properties
| Name | Type | Description |
|---|---|---|
event.id |
String | Id of the session object. |
event.type |
String | Event Type triggered. |
event.data |
Object | Data as appropriate to the event triggered. - onConnection - onConnectionClosed - onURLRedirection - onError - onResize |
onSessionCreated(sessionObject)
Callback having the session object created.
Parameters
| Name | Type | Description |
|---|---|---|
sessionObject |
Session | Session object to interact with the session like register and handle events, start and disconnect. |
Example
function sessionCreated(sessionObject){
//Handle session interactions like events, start, disconnect here.
//ICADATA has been constructed for example. Recommending to use StoreFront/WebInterface SDK to get ICA.
//Refer session.start() for more details.
var icaData = {
"Domain":"abcd",
"ClearPassword":"xxxxxxxxx",
"InitialProgram":"#Desktop",
"Title":"Desktop",
"Address":"xx.xx.xx.xx",
"Username":"xyz"
};
var launchData = {"type" :"json",value :icaData};
sessionObject.start(launchData);
}
<!--NeedCopy-->
Global
In this article
Copied!
Failed!