Connect method

Top  Previous  Next

 

The 'connect' method creates a remote desktop connection to the remote machine and positions it on the specified html structure. In order to do so, it expects a JSON argument in which all the connection settings should be informed.

If you want to understand exactly how each JSON parameter will reflect on the connection, read the next topics:

 

Placement parameters

Destination and authentication parameters

Settings parameters

Features parameters

Events parameters

Toolbar customization parameters

 

Right below you will find a code excerpt showing the connect method and all its possible parameters set. Note: they should not be used all at the same time, because each environment will require different parameters:

 

The Placement parameters may be required or not, depending on the connection mode (remote or local).
The Destination and Authentication parameters will be required depending on the authentication mode set on Thinfinity® Remote Desktop Server manager.
The rest of the parameters (Settings, Features, Events and Toolbar Customization) are optional and should be sent whenever you need to change a determined Thinfinity® Remote Desktop Server behaviour or enable and configure its features.

 

 

mythinrdp.connect({

                 

// Placement

 targetWindow: "substitute with the iframe id or window name",

 postpage:     "connection.html",

 exitURL :     "about:blank",

 divId :       "deskdiv",

 

   // SDK Settings

centered:

false,

overrideDefaults:

false,

showOnStart:

true,

showToolbar:

false,

hidePointer:

false,

kbdControl:

true,

mouseControl:

true,

touchControl:

true,

tcpReadCount:

true,

tcpReadWait:

true,

checkBeforeWindowClose:

true,

                 

 // 'General' tab

profileKey:

"substitute with the profileKey when using Access Profiles",

computer:

"substitute with the remote desktop/application IP",

username:

"substitute with the remote desktop username credential",

password:

"substitute with the remote desktop password credential",

askForCredentials:

false,

disablenla:

false,

desttype:

"substitute with the destination type (for VM's)",

destinfo:

"substitute with the destination info (for VM's)",

       

 // 'Program' tab

startprg:

0,

command:

"substitute with the app path",

directory:

"substitute with the app context dir",

cmdargs:

"substitute with the app arguments",

 

 // 'Display' tab

bpp:

16,

resolution:

"fittobrowser",

width:

$(window).width(),

height:

$(window).height(),

imagequality:

1,

clientAck:

0,

 

 // 'Experience' tab

 experience: {

enableRemoteFx:

true,

desktopbackground:

false,

visualstyles:

false,

menuwindowanimation:

false,

fontsmoothing:

false,

showwindowcontent:

false,

desktopcomposition:

false

 },

 

 // 'Advanced' tab

unicodekeyboard:

true,

kbdLayout:

"substitute with remote desktop keyboard layout",

console:

false,

wscompression:

true,

savesession:

false,

relativeTouch:

true,         //mobile

disableExtKeys:

true,         //mobile

tbSize:

"medium",     //mobile

 

 // 'Resources' tab

 printer: {

enabled:

false,

setasdefault:

true,

name:

"substitute with the printer name",

driver:

"substitute with the printer driver"

 },

 

 clipboard: true,

 

 disk: {

enabled:

true,

name:

"substitute with your desired disk name"

 },

 

 sound: {

 

enabled:

true,

quality:

-1

},

 

 // Events

 events: {

onServerConnecting  

: function (reconnecting) { },

onServerConnect

: function () { },

onQueryDisconnect

: function () { },

onServerConnectionError

: function (errMessage) { },

onServerDisconnect

: function () { },

onExecResult

: function (cmd) { },

onExecRemoteApp

: function (cmd) { },

onInteractionRequired

: function () { },

onSessionStart

: function () { },

onSessionEnd

: function (message) { }

 },

 

 // Toolbar customization

 createToolbar:       true,

 toolbarVisible:     true,

 toolbarRestrictions: [

"actionsMenuBtn",

//"Actions"

"actionsMenuBtn.refresh",

//"Refresh"

"actionsMenuBtn.ssnShareBtn",

//"Share session"

"actionsMenuBtn.sendKeysBtn",

//"Send Keys..."

"actionsMenuBtn.sendKeysBtn.ctrlAltDelBtn",

//"Ctrl + Alt + Del"

"actionsMenuBtn.sendKeysBtn.ctrlEscBtn",

//"Ctrl + Esc"

"actionsMenuBtn.sendKeysBtn.shiftCtrlEscBtn",

//"Shift + Ctrl + Esc"

"actionsMenuBtn.sendKeysBtn.windowsExplorerBtn",

//"Shell Explorer"

"actionsMenuBtn.sendKeysBtn.runBtn",

//"Run"

"actionsMenuBtn.sendKeysBtn.altTabBtn",

//"Alt + Tab"

"actionsMenuBtn.sendKeysBtn.altShiftTabBtn",

//"Alt + Shift + Tab"

"actionsMenuBtn.sendKeysBtn.altEscBtn",

//"Alt + Esc"

"actionsMenuBtn.sendKeysBtn.leftWinBtn",

//"Left Win Key"

"actionsMenuBtn.sendKeysBtn.rightWinBtn",

//"Right Win Key"

"actionsMenuBtn.viewOptionsBtn",

//"View params & layout"

"fileMenuBtn",

//"File transfer"

"fileMenuBtn.fileManBtn",

//"File Manager"

"fileMenuBtn.uploadBtn",

//"Upload"

"fileMenuBtn.downloadBtn",

//"Download"

"optionsMenuBtn",

// "Options"

"optionsMenuBtn.scaleBtn",

//"Scale"

"optionsMenuBtn.imgQualityBtn",

//"Image Quality"

"optionsMenuBtn.imgQualityBtn.imgQHighestBtn",

//"Highest"

"optionsMenuBtn.imgQualityBtn.imgQOptimalBtn",

//"Optimal"

"optionsMenuBtn.imgQualityBtn.imgQGoodBtn",

//"Good"

"optionsMenuBtn.imgQualityBtn.imgQPoorBtn",

//"Poor"

"optionsMenuBtn.keyboardMode",

//"Disable Shortcuts"

"disconnectBtn",

//"Disconnect"

  ]

});

 

 

Note: If you are using the connect method and the customsettings.js file, remember that the latter overrides the connect method's settings.

Read more:

Placement
Destination and Authentication
Settings
Features
Events
Toolbar Customization
Browser Resizing
Keystroke Methods
SSL Certificate
Demos