The TTerm Connect Javascript API is aimed at web developers whose task it is to create and maintain an embedded version of TTerm Connect within an existing of custom made webpage. TTerm Connect version 2.0 has brought in a range of changes and enhancements across the software, including to the API.

  This article describes features available in TTerm Connect 2.0 and above.

Please note that The TTerm Connect Javascript API is used to deploy embedded versions of TTerm Connect within an existing or custom made webpage. Information described in this article is only relevant to users who are currently making use of this feature.

As much as possible Turbosoft has maintained API compatibility with version 1, exceptions are noted below. If you encounter difficulty when updating webpages to work with version 2 of TTerm Connect please contact Turbosoft support. More detailed information can be found in the TTerm Connect Javascript API document, included in your installation.

API 2.0 Important Changes

Legacy references to TTCloud are now addressable as TTermConnect, for example:

let mySession = new TTermConnect.Session(); 

The TTCloud reference is retained for backwards compatibility.

The method for connecting the session to a service is unchanged,

mySession.Service(server, username, password, task, isGuest); 

however the server parameter is no longer supplied through the global InstallConnMgrURL property as it was in version 1.

Version 2 of TTerm Connect has the added support for multi-server installations for load balancing and redundancy and as such, this property is no longer available.

Instead a server URL should be obtained through TTermConnect.getBaseServer(). An example of this method can be found in the included full screen example embedded project included with your installation. For more details see the Guide to Embedding TTerm Connect in a Webpage document which is also included with your installation.

The onCommConnect event is now enabled by default. Note that a handler for the event must still be assigned.

Some minor usability improvements have been made such as aliasing methods that used Australian/British English spellings to US English. For example TTermSession.Initialise() is now also available as TTermSession.Initialize(). For backwards compatibility, both methods are valid.

The range of methods and events available has been greatly expanded. For a full list please refer to the TTerm Connect Javascript API document, included in your installation.

Related Articles: