LogoLogo
HomeContact UsRegister for a live demo!Get a Quote
  • Thinfinity Remote Desktop 5
  • About This Document
  • Introduction
  • What's new in 5.0
  • Architecture
  • Security
  • Upgrade from 4.0
  • Getting Started Section
    • Getting Started
    • Installing Thinfinity® Remote Desktop
    • Using Thinfinity® Remote Desktop for the First Time
      • Verifying the Communication Settings
      • Connecting to a desktop
    • Customizing Thinfinity® Remote Desktop
      • Setting the Access Security Level
        • Access Profiles
          • RDP Profiles
            • Creating an RDP Profile
            • Editing an RDP Profile
            • Disabling an RDP Profile
            • Removing an RDP Profile
            • The "[+]" Profile
          • Weblink Profiles
            • Creating a Weblink Profile
            • Editing a Weblink Profile
            • Disabling a Weblink Profile
            • Removing a Weblink Profile
          • RD Web Access Profiles
            • Creating a RD Web Access Profile
            • Editing a RD Web Access Profile
            • Disabling a RD Web Access Profile
            • Removing a RD Web Access Profile
          • VNC / RFB Profile
            • Creating a VNC Profile
            • Editing a VNC Profile
            • Disabling a VNC Profile
            • Removing a VNC Profile
          • Telnet/SSH profile
            • Creating a Telnet Profile
            • Editing a Telnet Profile
            • Disabling a Telnet Profile
            • Removing a Telnet Profile
      • Testing Internal Access
      • Configuring Internet Access
      • Enabling Remote Sound
      • Mapping Remote Drives
        • Intermediate Disks
        • Shared Folders
    • After Customization
      • Connecting to a Desktop
      • Connecting to an Application
      • Performing a File Transfer
        • Navigating
        • File Options
        • Remote Folder Area Options
        • Downloading and Uploading files
    • Supported RDP Shortcut Keys
  • Advanced Settings Section
    • Advanced Settings
    • Thinfinity® Remote Desktop Manager
      • General
      • Broker
      • Authentication
        • OAuth/2
          • Methods
          • Settings
          • Mappings
          • Configure OAuth with Okta
          • Configure OAuth with Auth0
        • RADIUS
          • Settings
          • Mappings for SSO
        • TOTP (Time-based One-time Password)
          • TOTP Settings
      • Access Profiles
        • RDP Profile Editor
          • General
            • Setting up a Hyper-V Profile
            • Setting up an RDS Collection Profile
          • Display
          • Resources
          • Program
          • Experience
          • Advanced
          • Printer
          • Permissions
          • Restrictions
          • Access Hours
          • Authentication methods
        • Web Link Profile Editor
          • Web Link
          • Permissions
        • RD Web Access Editor
          • General
          • Permissions
        • VNC / RFB Profile Editor
          • Display
          • Permissions
          • Restrictions
          • Access Hours
          • Authentication methods
        • Telnet / SSH Profile Editor
          • Display
          • SSL
          • SSH
          • Options
          • Permissions
          • Authentication methods
          • Access Hours
          • Restrictions
      • Folders
      • Permissions
      • External DLL Authentication Method Settings
      • Duo Authentication Method Settings
        • How to configure DUO
      • SAML Authentication Method Settings
        • Configure SAML with Okta
        • Configure SAML with Centrify
  • Gateway Manager
    • Managing the SSL Certificate
      • The Default Embedded Certificate
      • A Self-Signed Certificate
      • A CA Certificate
  • License Manager
    • License Activation
    • Proxy Activation
    • Get a new Trial Serial Number
    • Activate a Serial Number Online
    • Activate a Serial Number Offline
    • Registering Your License With The License Server Manager
  • Custom Settings
    • Extend the Remote Desktop’s Toolbar
  • Customizing the Toolbar
    • Using customsettings.js
    • Using the 'connect' Method
  • Remote FX
  • Save Session
    • Record a Session
    • Play Recorded Sessions
  • Multi-touch Redirection
  • Enhanced Browser and DPI Support
    • Model Inheritance
    • Property Reference
    • The Calculation Process
    • Examples
  • Silent Install Options
  • Credentials Management
    • User-based Access Profiles
    • Credentials Management
  • Customize Translation
  • Mobile Devices Section
    • Mobile Devices
    • Getting into Thinfinity® Remote Desktop
    • Mouse Control
    • Keyboards and Toolbars
    • Gestures
    • Disconnecting from Thinfinity® Remote Desktop
    • iPad Application
      • Configuration
      • Side Bar
  • Scaling and Load Balancing Section
    • Scaling & Load Balancing
    • Scaling and Load Balancing Configurations
    • Installing Components
    • Configuring a Load Balancing Scenario
    • How to configure your license
  • Integrating Thinfinity® Remote Desktop Section
    • Integrating Thinfinity® Remote Desktop
    • SDK
      • Deploying
      • Using the SDK
      • SDK Login
      • Connect method
        • Placement
        • Destination and Authentication
        • Settings
          • kbdLayout Values
        • Features
        • Events
        • Toolbar Customization
      • Browser Resizing
      • Keystroke Methods
      • SSL Certificate
      • Demo
    • External Authentication
      • Apikey
    • Single Sign On
      • Facebook OAuth Authentication Example
      • Google OAuth/2
        • Google Client ID for Web Applications
      • RADIUS
    • Customizing the Web Interface
      • Changing the Logo
      • Customizing the Web Files
      • Files Location
    • Web Services API
      • Architecture
      • Installing the Web Service
      • Setting up the Communication Settings
      • Profiles Web Service
        • Methods
        • Types
          • The WS Profile type
        • The Demo Applications
      • Analytics Web Service
        • Methods
        • Types
          • WSQueryInfo
          • WSQueryRange
          • WSDBLoginRecord
          • WSSessionRecord
          • WSDBConnectionRecord
          • WSDBBrowserRecord
        • The Demo Application
    • One-Time-URL
      • Configuring the Connection
      • Enabling Features
  • User guide Section
    • User Guide
    • Logging In
    • Advanced Web Features
      • Tree View
      • Listing Options
      • Search bar
    • Accessing from Mobile Devices
      • Connecting with Open Parameters
        • General
        • Display
        • Resources
        • Program
        • Experience
        • Advanced
      • Connecting with Profiles
    • Toolbar
      • Actions
      • File Transfer
      • Options
      • Disconnect
    • Features
      • File Transfer
        • Navigating
        • File Options
        • Remote Folder Area Options
        • Downloading and Uploading files
      • Remote Printer
      • Remote Sound
      • Share Session
      • Mapped Drives
      • Analytics
        • Sessions
        • Connections
        • Logins
        • Browsers
        • Filter
        • Configuring MS SQL Server
          • Analytics Tables Reference
    • Disconnecting
Powered by GitBook
On this page

Was this helpful?

Export as PDF
  1. Integrating Thinfinity® Remote Desktop Section
  2. SDK

Connect method

PreviousSDK LoginNextPlacement

Last updated 4 years ago

Was this helpful?

Connect method

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:

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 may be required or not, depending on the connection mode (remote or local).

· The will be required depending on the authentication mode set on Thinfinity® Remote Desktop Server manager.

· The rest of the parameters (, , and ) 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: {
},
 // 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.

Placement parameters
Destination and authentication Parameters
Settings parameters
Features parameters
Events parameters
Toolbar customization parameters
Placement parameters
Destination and Authentication parameters
Settings
Features
Events
Toolbar Customization