Class HostIntegratorRejuvenationSession
This class and the elements in this class support the Verastream .NET API framework and are not intended to be used directly in your code.
Inherited Members
Namespace: WRQ.Verastream.HostIntegrator
Assembly: WRQ.Verastream.HostIntegrator.dll
Syntax
public class HostIntegratorRejuvenationSession : HostIntegratorSession
Constructors
HostIntegratorRejuvenationSession()
This class and the elements in this class support the Verastream .NET API framework and are not intended to be used directly in your code.
Declaration
public HostIntegratorRejuvenationSession()
Remarks
This class and the elements in this class support the Verastream .NET API framework and are not intended to be used directly in your code.
Properties
LegacyRejuvenation
Sets or gets whether legacy rejuvenation behavior is in effect.
Declaration
public bool LegacyRejuvenation { get; set; }
Property Value
Type | Description |
---|---|
bool | Sets or gets whether the current session is using legacy rejuvenation behavior. |
Remarks
When legacy rejuvenation behavior is in effect, the names of some VHI model objects with names that end in _HIDE, _SHOW, _NOCACHE, etc. are applied.
ScreenCRC
This class and the elements in this class support the Verastream .NET API framework and are not intended to be used directly in your code.
Declaration
public int ScreenCRC { get; }
Property Value
Type | Description |
---|---|
int | This class and the elements in this class support the Verastream .NET API framework and are not intended to be used directly in your code. |
Remarks
This class and the elements in this class support the Verastream .NET API framework and are not intended to be used directly in your code.
Exceptions
Type | Condition |
---|---|
HostIntegratorConnectorException | Thrown when client is not connected |
HostIntegratorException | Thrown if the connection is for metadata only |
TerminalUpdatesPresent
This class and the elements in this class support the Verastream .NET API framework and are not intended to be used directly in your code.
Declaration
public bool TerminalUpdatesPresent { get; }
Property Value
Type | Description |
---|---|
bool | This class and the elements in this class support the Verastream .NET API framework and are not intended to be used directly in your code. |
Remarks
This class and the elements in this class support the Verastream .NET API framework and are not intended to be used directly in your code.
Exceptions
Type | Condition |
---|---|
HostIntegratorConnectorException | Thrown when client is not connected |
HostIntegratorException | Thrown if the connection is for metadata only |
Methods
GetTerminalScreen()
This class and the elements in this class support the Verastream .NET API framework and are not intended to be used directly in your code.
Declaration
public TerminalScreen GetTerminalScreen()
Returns
Type | Description |
---|---|
TerminalScreen | This class and the elements in this class support the Verastream .NET API framework and are not intended to be used directly in your code. |
Remarks
This class and the elements in this class support the Verastream .NET API framework and are not intended to be used directly in your code.
Exceptions
Type | Condition |
---|---|
HostIntegratorConnectorException | Thrown when client is not connected. |
HostIntegratorException | Thrown if the connection is for metadata only |
SetHiddenAttributes(IList)
Sets the list of attributes that are to have their text hidden.
Declaration
public void SetHiddenAttributes(IList ha)
Parameters
Type | Name | Description |
---|---|---|
IList | ha | A list of strings containing the names of the attributes that are to be hidden in the form EntityName.AttributeName |
Remarks
The list of attributes will only be processed by the connector when LegacyRejuvenation is set to false.
WaitForStableDisplay()
This class and the elements in this class support the Verastream .NET API framework and are not intended to be used directly in your code.
Declaration
public void WaitForStableDisplay()
Remarks
This class and the elements in this class support the Verastream .NET API framework and are not intended to be used directly in your code.
Exceptions
Type | Condition |
---|---|
HostIntegratorConnectorException | Thrown when client is not connected. |
HostIntegratorException | Thrown if the connection is for metadata only |
WaitForStableDisplay(int, int)
This class and the elements in this class support the Verastream .NET API framework and are not intended to be used directly in your code.
Declaration
public void WaitForStableDisplay(int durationMilliSeconds, int timeLimitSeconds)
Parameters
Type | Name | Description |
---|---|---|
int | durationMilliSeconds | Duration of host silence to wait for |
int | timeLimitSeconds | Maximum time to wait for keyboard unlock and host silence |
Remarks
This class and the elements in this class support the Verastream .NET API framework and are not intended to be used directly in your code.
Exceptions
Type | Condition |
---|---|
HostIntegratorConnectorException | Thrown when client is not connected. |
HostIntegratorException | Thrown if the connection is for metadata only |