Interface IClientSession

Provides information about the currently connected client.

Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI

Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll

Syntax

public interface IClientSession

Properties

AuthUsername

Gets the authenticated user name (if any) that is currently assigned to the session.

Declaration

string AuthUsername { get; }

Property Value

Type	Description
string	User name authenticated to AADS

Remarks

Gets the authenticated user name (if any) that is currently assigned to the session. This is not the same as any user name required to log in to the host application. (For that information check the model variables.) This parameter may be either null or an empty string if no client is currently connected or no credentials were used to connect to the server.

ClientSessionID

Gets the VHI client session ID.

Declaration

int ClientSessionID { get; }

Property Value

Type	Description
int	The client session ID.

Remarks

Gets the VHI client session ID. This is the ID that appears in the VHI log.

Methods

GetClientStateObject(string)

Gets the object bound to the specified name in this client session, or null if no object is bound to the name.

Declaration

object GetClientStateObject(string name)

Parameters

Type	Name	Description
string	name	Name the name of the object

Returns

Type	Description
object	The object bound to the specified name or null if none

IsClientStateObject(string)

Determines if the name has a binding.

Declaration

bool IsClientStateObject(string name)

Parameters

Type	Name	Description
string	name	The bind name to evaluate

Returns

Type	Description
bool	True if there is something stored under this name, false otherwise. Note that the return will be true even if the name is bound to a null reference.

Remarks

Determines if the name has a binding. The binding may refer to an actual object or it may be null.

SetClientStateObject(string, object)

Binds an object to this client session, using the name specified.

Declaration

void SetClientStateObject(string name, object data)

Parameters

Type	Name	Description
string	name	The name to which to bind the object
object	data	The object to bind

Remarks

Binds an object to this client session, using the name specified. If an object of the same name is already bound to the session, the object is replaced.