Citrix Workspace app for HTML5 HDX SDK

Session

July 31, 2023

Contributed by:

new Session()

Members

container

Contains the type and value of the container where the session is launched.

Properties

Name Type Description

container

Object

Properties

Name	Type	Description
`type`	String	Type of the container. Will be set to "iframe" or "window" when launchType is set to "embed" or "newtab" respectively.
`value`	Object	Contains the iframe DOM object or reference to the window where the session is launched based on the launchType.

(readonly) id

Properties

Name	Type	Description
`id`	String	ID of the object

Methods

(inner) addListener(eventType, eventListener)

Registers the eventListener on the eventType.

Parameters

Name	Type	Description
`eventType`	String	Type of the event for which the listener needs to be attached. Supported event types: - onConnection - onConnectionClosed - onURLRedirection - onError - onResize
`eventListener`	eventListener	Listener to handle the event

Example

// Adding onConnection event handler
function connectionHandler(event){
	console.log("Event Received : " + event.type);
	console.log(event.data);
}
sessionObject.addListener("onConnection",connectionHandler);

// Adding onConnectionClosed event handler
function connectionClosedHandler(event){
	console.log("Event Received : " + event.type);
	console.log(event.data);
}
sessionObject.addListener("onConnectionClosed",connectionClosedHandler);

// Adding onError event handler
function onErrorHandler(event){
	console.log("Event Received : " + event.type);
	console.log(event.data);
}
sessionObject.addListener("onError",onErrorHandler);

//Adding onURLRedirection event handler
function onURLRedirectionHandler(event){
	console.log("Event Received : " + event.type);
	console.log(event.data);
}
sessionObject.addListener("onURLRedirection",onURLRedirectionHandler);

//Adding onResize event handler
function onResizeHandler(event){
	console.log("Event Received : " + event.type);		
	console.log(event.data);
}
sessionObject.addListener("onResize",onResizeHandler);
<!--NeedCopy-->

(inner) addToolbarBtns(customToolbarData)

Adds the custom buttons to the in-session toolbar.

Parameters

Name Type Description

customToolbarData

Array.<Object>

Array of objects containing the custom toolbar buttons to be added where each object contains more details of the button to be added.

Note: Toolbar should be enabled to use this method.

Properties

Name	Type	Description
`id`	String	id of the button
`config.isPrimary`	boolean	Value set to true specifies that the button to be added to primary toolbar buttons. Setting to false would add to secondary menu (present under more button). Defaults to true.
`config.imageUrl`	String	Image url of the button. Mandatory when the button is added to primary toolbar button. Note: Recommendation is to host the images where SDK files are hosted and give full path of the image. Other option is to use the data URL of the image. If the images are hosted in origin other than that of SDK then Content security policy in HDXEngine.html has to be edited to allow the images to be fetched.
`config.position`	String	Specifies the position of the custom button when added as primary toolbar button.For secondary custom buttons it would be appended to the menu shown on clicking more button. 1) Setting to 'front' would add the button to the front of the toolbar (immediately after receiver button). 2) Setting to 'rear' would add the button before more button. Note : For secondary custom buttons it would be appended to the menu shown on clicking more button. Defaults to 'front' when unspecified.
`config.toolTip`	String	Value is set as tooltip if the custom button is primary. For secondary the value is shown as the menu item.
`handler`	eventListener	Event listener that listens for the click of the custom toolbar button.

Examples

Example 1: Adding help custom button to primary toolbar and position is set to rear(added before more button)

function helpButtonHandler(eventObj){
	console.log("Event Received : " + event.type);
	console.log(event.data);
}

var customToolbarData = [{"id" :"help","config":{"position":"rear","imageUrl":"http://<path_of_the_image>/help.png","toolTip":"Help"},"handler":helpButtonHandler}];
sessionObject.addToolbarBtns(customToolbarData);
<!--NeedCopy-->

Example 2: Adding back and forward buttons that allows navigation of the webpage in browser and position is set to front (added after Workspace app button).

function backButtonHandler(eventObj){
	console.log("Event Received : " + event.type);
	console.log(event.data);
	sessionObject.sendSpecialKeys(["ALT_KEY","LEFT_ARROW"]);
}
function forwardButtonHandler(eventObj){
	console.log("Event Received : " + event.type);
	console.log(event.data);
	sessionObject.sendSpecialKeys(["ALT_KEY","RIGHT_ARROW"]);
}

var customToolbarData = [];
customToolbarData.push({"id" :"back","config":{"position":"front","imageUrl":"http://<path_of_the_image>/back.png","toolTip":"Back"},"handler":backButtonHandler});
customToolbarData.push({"id" :"forward","config":{"position":"front","imageUrl":"http://<path_of_the_image>/fwd.png","toolTip": "Forward"},"handler":forwardButtonHandler});

sessionObject.addToolbarBtns(customToolbarData);<br/><br/><br/>
<!--NeedCopy-->

Example 3: Adding help custom button as primary toolbar with position set to rear and contact us button as secondary button.

function helpButtonHandler(eventObj){
	console.log("Event Received : " + event.type);
	console.log(event.data);
}
function contactUsButtonHandler(eventObj){
	console.log("Event Received : " + event.type);
	console.log(event.data);
}
var customToolbarData = [];
customToolbarData.push({"id" :"help","config":{"position":"rear","imageUrl":"http://<path_of_the_image>/help.png","toolTip":"Help"},"handler":helpButtonHandler});
customToolbarData.push({"id" :"contactUs","config":{"toolTip":"Help","isPrimary":false},"handler":contactUsButtonHandler});

sessionObject.addToolbarBtns(customToolbarData);
<!--NeedCopy-->

(inner) changeResolution(bounds)

Changes the resolution of the session.

Parameters

Name	Type	Description
`bounds`	Object	Contains session resolution settings

Properties

Name	Type	Description
`bounds.autoresize`	boolean	Should be set to false to give fixed width and height to session. If this value is set to true then the session is resized to match the size of iframe element or the tab.
`bounds.width`	Number	Width of the session specified in pixels. This value will be set only when autoresize is set to false.
`bounds.height`	Number	Height of the session specified in pixels. This value will be set only when autoresize is set to false.

Examples

Example 1: To change resolution to fixed width and height

var bounds = {
	"autoresize":false,
	"width": "800",
	"height":"600"
}
sessionObject.changeResolution(bounds);
<!--NeedCopy-->

Example 2: To change the session resolution to match the iframe element or tab size

var bounds = {
	"autoresize": true
}
sessionObject.changeResolution(bounds);
<!--NeedCopy-->

(inner) disconnect()

Disconnects the session.

(inner) logoff()

Sends logoff to the session.

(inner) removeListener(eventType, eventListener)

Removes the eventListener on the eventType.

Parameters

Name	Type	Description
`eventType`	String	Type of the event for which the listener needs to be removed. Supported event types: - onConnection - onConnectionClosed - onURLRedirection - onError - onResize
`eventListener`	eventListener	Listener to handle the event

Example

//Removing the event handler for onConnection event
function connectionHandler(eventObj){
	console.log("Event Received : " + event.type);
	console.log(event.data);
}
sessionObject.removeListener("onConnection",connectionHandler);
<!--NeedCopy-->

(inner) removeToolbarBtns(toolbarButtonIds)

Removes the custom toolbar buttons added to in-session toolbar.

Parameters

Name	Type	Description
`toolbarButtonIds`	Array <String>	Array of custom toolbar button ids to be removed.

Example

Example 1: Removing the help button added using addToolbarBtns example.

sessionObject.removeToolbarBtns(["help"]);
<!--NeedCopy-->

Example 2: Removing multiple buttons say back and forward buttons added using addToolbarBtns example.

sessionObject.removeToolbarBtns(["back","forward"]);
<!--NeedCopy-->

(inner) sendSpecialKeys(keys)

Sends a key combination to the session.

Parameters

Name	Type	Description
`keys`	Array	Array of strings with each one representing a key. Supported keys Alt, Control, Shift, ArrowDown, ArrowLeft, ArrowRight, ArrowUp, Home, End, PageUp, PageDown, Backspace, Delete, F5, PrintScreen,Insert, Escape, Tab. Till 1.1 version only “ctrl+alt+del” was supported. From 1.2 version, more key combinations can be sent to session.

Example

Example 1: Sends Ctrl+alt+delete to the session.

var keys = ["Control","Alt","Delete"];
sessionObject.sendSpecialKeys(keys);
<!--NeedCopy-->

Example 2: To preview different apps running inside session, Ctrl+alt+tab can be sent.

var keys = ["Control","Alt","Tab"];
sessionObject.sendSpecialKeys(keys);
<!--NeedCopy-->

(inner) start(launchData)

Starts the session.

Parameters

Name	Type	Description
`launchData`	Object	Contains the type and value of ICA.

Properties:

Name	Type	Description
`launchData.type`	String	Specifies the data type of ICA data. Allowed values are “json” or “ini”.
`launchData.value`	String	ICA data to start the session. It should be a JSON object when type is “json” or a string read from a .ini file when type is “ini”.

Examples

Example 1: When ICA data is in JSON format

var icaObj = {
	"ClientName":"HTML5-Receiver",
	"Domain":"<domain_name>",
	"ClearPassword":"<password>",
	"InitialProgram":"<initial program",
	"Title":"<title>",
	"Address":"<ip address>",
	"Username":"<user name>",
	"wsPort":"<port val>"
}
var launchData = {"type" : "json",value : icaObj};
sessionObject.start(launchData);
<!--NeedCopy-->

Example 2: When ICA data is in INI format

var launchData = {"type" :"ini",value :"<ica data in ini format>"};
sessionObject.start(launchData);
<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Session

July 31, 2023

Contributed by:

July 31, 2023

Contributed by:

Session

Members

container

Properties

Properties

(readonly) id

Properties

Methods

(inner) addListener(eventType, eventListener)

Parameters

Example

(inner) addToolbarBtns(customToolbarData)

Parameters

Properties

Examples

(inner) changeResolution(bounds)

Parameters

Properties

Examples

(inner) disconnect()

(inner) logoff()

(inner) removeListener(eventType, eventListener)

Parameters

Example

(inner) removeToolbarBtns(toolbarButtonIds)

Parameters

Example

(inner) sendSpecialKeys(keys)

Parameters

Example

(inner) start(launchData)

Parameters

Properties:

Examples

In this article