Sessions Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents an abstract class used to create and handle the individual session classes.
public ref class Sessions abstract : System::Collections::IEnumerable
public abstract class Sessions : System.Collections.IEnumerable
type Sessions = class
interface IEnumerable
Public MustInherit Class Sessions
Implements IEnumerable
- Inheritance
-
Sessions
- Derived
- Implements
Constructors
Sessions(Boolean, Int32) |
Initializes a new instance of the Sessions class. |
Sessions(Boolean) |
Initializes a new instance of the Sessions class. |
Properties
ActiveSession |
Gets the currently active session or null. |
Count |
The number of current sessions, not counting any global ones. |
GlobalSession |
Gets the global session or null. |
Throttled |
Gets a Boolean value that specifies whether the sessions have been throttled or not. |
Methods
AddSession(String, Int32, Object, Guid) |
Adds a new session to the UII desktop |
AddSession(String, Int32, Object) |
Add a new session to the UII desktop. |
CloseAll() |
Closes all sessions. |
CloseSession(Session, Boolean) |
Closes the session and if it was the active session, assigns another session to be the active one. |
CreateSession(String, Int32, Object, Guid) |
Creates a session. |
CreateSession(String, Int32, Object) |
Creates a session. |
GetEnumerator() |
Gets an enumerator object that can iterate through the sessions. |
GetSession(Guid) |
Gets the session based on the sessionID. |
GetSession(Int32) |
Gets the session based on the callID. |
GetSession(String) |
Gets the session based on the customer ID. |
Save() |
Saves the sessions and returns an XML giving the state of all existing sessions. |
SetActiveSession(Guid) |
Sets the session whose ID is given to be the active one and updates the UI as needed. |
Events
SessionCloseEvent |
Raised to close the session. |
SessionHideEvent |
Raised to hide the session. |
SessionShowEvent |
Raised to show the session. |