Connect method

 Top  Previous  Next

 

The "connect" method creates a connection with the remote machine and positions the remote desktop connection 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

 

Right below you will find the connect method with all the possible parameters set. They should not be sent all together, because each environment will require different parameters to be set:

 

•The Placement parameters will be required depending on the connection mode (remote or local).
•The Destination and Authentication parameters will be required depending on the authentication mode set on ThinRDP manager.
•The other parameters (Settings, Features and Events) are optional and should be sent whenever you need to change a determined ThinRDP 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,

                 tcpReadCount:     true,

                 tcpReadWait:     true,

 

                 // Tab General

                 profileKey: "substitute with the profileKey if 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)",

 

                 // Tab Program

                 startprg: 0,

                 command:   "substitute with the app path",

                 directory: "substitute with the app context dir",

                 cmdargs:   "substitute with the app arguments",

 

                 // Tab Display

                 bpp: 16,

                 resolution:"fittobrowser",

                 width: $(window).width(),

                 height: $(window).height(),

                 imagequality: 1,

                 clientAck: 0,

 

                 // Tab Experience

                 experience: {

                         desktopbackground: false,

                         visualstyles: false,

                         menuwindowanimation: false,

                         fontsmoothing: false,

                         showwindowcontent: false,

                         desktopcomposition: false

                 },

 

                 // Tab Advanced

                 unicodekeyboard: true,

                 kbdLayout: "substitute with remote desktop keyboard layout",

                 console: false,

                 wscompression: true,

                 relativeTouch: true, //mobile

                 disableExtKeys: true, //mobile

                 tbSize: "medium",     //mobile

                 

                 // Tab Resources

                 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) { },

                         onSessionStart               : function () { },

                         onSessionEnd                 : function (message) { },

                 }

 

                   // Toolbar customization

                 createToolbar:     true,

                 toolbarVisible:     true

});