The Session type exposes the following members.
Constructors
Methods
| Name | Description | |
|---|---|---|
 | ChangeStation |
Changes the station for the session.
|
| ChangeStationAsync |
Asynchronously changes the station for the session.
|
| CheckSession |
Verify that there is a connected session.
|
| Connect |
Connects the session using the specified settings.
|
| ConnectAsync |
Asynchronously connects the session using the specified settings.
|
| Disconnect()()()() |
Disconnects the Session.
|
| Disconnect(Boolean) |
Disconnects the Session.
|
| DisconnectAsync(AsyncCompletedEventHandler, Object) |
Asynchronously disconnects the Session.
|
| DisconnectAsync(Boolean, AsyncCompletedEventHandler, Object) |
Asynchronously disconnects the Session.
|
| Dispose()()()() | Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. |
 | Dispose(Boolean) |
Releases the resources used by the Session.
|
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
| Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| ForceUserLogout |
Force logout a user from all the applications.
|
| ForceUserLogoutAsync |
Asynchronously logs out user from all the applications.
|
 | GetAllowableAuthentications(AllowableAuthenticationsParameters) |
Gets the allowable authentication types.
|
| GetAllowableAuthentications(HostSettings) |
Gets the allowable authentication types.
|
| GetAllowableAuthentications(HostSettings, String) |
Gets the allowable authentication types.
|
| GetAuthenticationToken |
Gets the authentication token for the Session.
|
| GetAuthenticationTokenAsync |
Asynchronously gets the authentication token for the Session.
|
| GetAuthSettings |
Gets a copy of the AuthSettings.
|
| GetCachedAllowableAuthentications(String) |
Gets the cached allowable authentication types.
|
| GetCachedAllowableAuthentications(CachedAllowableAuthenticationsParameters) |
Gets the cached allowable authentication types.
|
| GetCachedAllowableAuthentications(String, String) |
Gets the cached allowable authentication types.
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetHostSettings |
Gets a copy of the HostSettings.
|
| GetSessionSettings |
Gets a copy of the SessionSettings.
|
| GetStationInfo |
Gets a copy of the StationInfo.
|
| GetStationSettings |
Gets a copy of the StationSettings.
|
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| SetAutoReconnectInterval(Int32) |
Sets the amount of time (in seconds) to wait between reconnection attempts when the connection has been lost.
|
| SetAutoReconnectInterval(Int32, Int32) |
Sets the amount of time (in seconds) to wait between reconnection attempts when the connection has been lost,
allowing a difference between the amount of time before an initial reconnect and
all subsequent reconnect attempts.
|
| SetReadyForInteractions |
Signals the application's readiness to make or receive Interactions.
|
| SetReadyForInteractionsAsync |
Asynchronously signals the application's readiness to make or receive Interactions.
|
| SetStationConnectionMode |
Sets the station connection mode for the session, which controls when the user is logged out of the station.
|
| SetStationConnectionModeAsync |
Asynchronously sets the station connection mode for the session, which controls when the user is logged out of the station.
|
| ToString | Returns a String that represents the current Object. (Inherited from Object.) |
Properties
| Name | Description | |
|---|---|---|
 | AdditionalUtcOffset |
Gets or sets an additional clock skew for the session.
|
| AttemptToSetThreadCulture |
Gets or sets a value indicating whether to attempt to set IceLib's background threads' CurrentUICulture.
|
| AutoReconnectEnabled |
Enables or disables automatic reconnection attempts when the connection is lost.
|
| AutoReconnecting |
Identifies whether an AutoReconnect is in the process of occurring.
|
| ClockSkew |
Gets the clock skew.
|
| ConnectionState |
Gets the current ConnectionState of the Session.
|
| ConnectionStateMessage |
Gets the most recent text description of the state of the Session.
|
| ConnectionStateReason |
Gets the current ConnectionStateReason of the Session.
|
| CultureInfo |
Gets the culture info, as specified by SessionSettings.IsoLanguage.
|
| CustomerName |
Gets the name of the customer to whom IC is licensed.
|
| DisplayName |
Gets the display name for the logged in user.
|
| EffectiveStation |
Gets the effective station that the user is logged in to.
|
| Endpoint |
Returns a new HostEndpoint containing the details of the currently connected HostEndpoint.
|
| ICServer |
Gets the name of the IC server to which the session is connected.
|
| InteractionCenterReleaseVersion |
Gets the release version information of the Interaction Center to which the session is connected (if available).
|
| IsEncrypted | Obsolete.
Returns whether the current connection is encrypted.
|
| RawSessionId |
The internal Session ID as a UInt32.
|
| SensitiveDataContext |
Gets the sensitive data context for this session.
|
| SessionId |
The internal Session ID.
|
| SessionManagerName |
Gets the relative distinguished name (RDN) of the SessionManager to which the session is connected.
|
| SessionManagerNameFQDN |
Gets the fully qualified domain name (FQDN) of the SessionManager to which the session is connected.
|
| SessionManagerReleaseVersion |
Gets the release version information of the Session Manager to which the session is connected (if available).
|
| SessionManagerVersion |
Gets the version number of the SessionManager to which the session is connected (if available).
|
| SupportedMedia |
Gets the supported media flags (SupportedMedia).
|
| UserAgreement |
Gets the user agreement text.
|
| UserId |
Gets the ID of the logged in IC user.
|
| UserLogOnId |
Gets the log on ID of the logged in IC user.
|
Events
| Name | Description | |
|---|---|---|
 | ConnectionStateChanged |
Occurs when the Session's ConnectionState changes.
|
| EffectiveStationChanged |
Occurs when the Session user's EffectiveStation changes.
|
| StationSettingsChanged |
Occurs when the Session's StationSettings changes.
|
