Global

Type Definitions

Connection

Defines how a Session connects when started--matches all documented properties for the FVTermParent ConnectFVTerm function
Type:
  • Object
Properties:
Name Type Description
application string (optional--overrides the SessionControl property of same name if defined) Name of application defined in web.config for screen recognition
hostName string Host name defined for the Inventu service that this session connects to
autoStart boolean If true the session will automatically connect to the host at start time
keepAliveOnClose boolean If true, the session will not be terminated/closed by the browser logic if the user closes the browser at the desktop level
userID string Can be set prior to start session--this is the UserID to be associated with the session in the Inventu Service
fnSessClass Session Needed at constructor time--defines class for sessions, such as FVSessions.HODSession-default is FVSessions.Session
Source:

Manager

The Manager Class is used to initialize the environment and host Session objects In September 2023, the FVSessions.config setting msgAPI was added with a default value of true. This now assumes that FVTermMsgApi.js instead of FVTermParent.js is the corresponding JS file providing the iFrame API management. FVTermMsgApi.js utilizes inter-window messaging instead of direct calls that require document.domain to be set in many environments. If you are using FVSessions.js with the direct API module FVTermParent.js, you will need to set FVSessions.config.msgAPI=false prior to creating a new connection.
Type:
Source:

Session

The Session class manages an individual FVTerm session and is created using the Manager
Type:
Source:

SessionControl

Keyed by SessionID -- included in the SessionDef object passed as the control parameter to the Manager Class Constructor
Type:
  • Object
Properties:
Name Type Description
onnewscreen function Event function called any time a new screen is received from the host
onclose function Event function called when the session is closed
onsend function Event function called whenever the user enters a screen
frameId string Optional frameID that this session should be opened/started in--if not set the name is 'FVSWin_' + the session id
connection Connection Defines how the session will connect during the Manager.StartSession function
Source:

SessionDef

Type:
  • Object
Properties:
Name Type Description
application string Default name of application defined in web.config for screen recognition -- can be overridden in session connection property
onnewscreen function Default Event function called any time a new screen is received from the host-- can be overridden for each Session in the sessions SessionControl object
onclose function Default Event function called when the session is closed-- can be overridden for each Session in the sessions SessionControl object
onsend function Default Event function called whenever the user enters a screen-- can be overridden for each Session in the sessions SessionControl object
sessions SessionControl One or more session definitions keyed by the sessionID
Source: