- Citrix Knowledge Center Configuring Html5
- Citrix Receiver For Html5 2020
Type Definitions¶
connectionParams¶
HTML5 Citrix Workspace app – updated with Workspace app for HTML5 1909; Citrix StoreFront Favorites, Categories, and Default View – added link to Citrix Blog Post How to land on the categories view in StoreFront 1811+ 2019 Aug 30: Citrix Receiver Versions – updated for Receiver 4.9.8000 (LTSR).
Configuration options to create the session.
Type:¶
- Powered by cloud computing services. Cws users only!!! For cws support contact ibm service desk at (800) 428-8268 warning unauthorized access to any state of california computing system containing us government or state of california information is a criminal violation of penal code section 502 and/or applicable federal law and is subject to civil and criminal sanctions.
- Beginning August 2018, Citrix Receiver will be replaced by Citrix Workspace app. While you can still download older versions of Citrix Receiver, new features and enhancements will be released for Citrix Workspace app. Citrix Workspace app is a new client from Citrix that works similar to Citrix Receiver and is fully backward-compatible with.
Properties:¶
| Name | Type | Description |
|---|
connectionParams | Object | Properties| Name | Type | Attributes | Description |
|---|
launchType | String | <optional>
| Takes 'newtab' or 'embed' as value. Defaults to 'newtab'.
'newtab' - launches the session in a new tab.
'embed' - Opens the session in an Iframe. | container | Object | Specifies the ID and the type of container for the session when launchType is embed.
Properties| Name | Type | Description |
|---|
id | String | ID of the iframe element to embed the session. Mandatory parameter when launchType is embed. | type | String | Type of the element to embed the session. Should be set to 'iframe'. |
| bounds | Object | <optional>
| Sets a fixed width and height to the session. Properties| Name | Type | Description |
|---|
autoresize | boolean | Should be set to false to give fixed width and height to session. By default, this value is set to true in which case the session is resized to match the size of iframe element or the tab. | width | Number | Width of the session specified in pixels. This value will be set only when autoresize is set to false. | height | Number | Height of the session specified in pixels. This value will be set only when autoresize is set to false. |
| closeOptions | Object | <optional>
| Action on disconnecting the session. Defaults to type='close'. Properties| Name | Type | Description |
|---|
type | String | Specifies the type of action.
type=”redirectUrl” would redirect the tab to the URL specified in value.
type=”close” would set the iframe src to 'about:blank' when launchType is 'embed' and closes the tab when launchType is 'newtab'. | value | String | Specifies the URL to be redirected. When type is set to 'close',this value would be ignored. | showDisconnectAlert | boolean | A prompt would be shown to the user to stay/leave the current page when the session is about to disconnect due to the actions like close/reload of the tab.
If the value is set to true then the prompt is displayed otherwise prompt won't be shown.
Default value is true. |
| preferredLang | String | <optional>
| Specifies the preferred language code to be used inside the session. If the language code specified is either invalid or unsupported then it falls back to 'en'.
Supported language codes : en, de, es, fr, ja, ko, ru, zh, zh-cn, zh-tw
If the value is unspecified then the browser's language code is used. | preferences | Object | <optional>
| JSON to hide/show toolbar or individual toolbar items, suppressing the FTU, URLRedirection and error dialog.
Refer to the example below. |
|
Example¶
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
|
onSessionCreated¶
Callback having the session object created.
Parameters:¶
Citrix Knowledge Center Configuring Html5
| Name | Type | Description |
|---|
sessionObject | Session | Session object to interact with the session like register and handle events, start and disconnect. |
Citrix Receiver For Html5 2020
Example¶