Sessions Class
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2013, Dynamics CRM 2015, Dynamics CRM 2016
Represents an abstract class used to create and handle the individual session classes.
Namespace: Microsoft.Uii.Csr
Assembly: Microsoft.Uii.Csr.Core (in Microsoft.Uii.Csr.Core.dll)
Inheritance Hierarchy
System.Object
Microsoft.Uii.Csr.Sessions
Microsoft.Uii.Desktop.SessionManager.AgentDesktopSessions
Syntax
public abstract class Sessions : IEnumerable
Public MustInherit Class Sessions
Implements IEnumerable
Constructors
Name | Description | |
---|---|---|
Sessions(Boolean) | Initializes a new instance of the Sessions class. |
|
Sessions(Boolean, Int32) | Initializes a new instance of the Sessions class. |
Properties
Name | Description | |
---|---|---|
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
Name | Description | |
---|---|---|
AddSession(String, Int32, Object) | Add a new session to the UII desktop. |
|
AddSession(String, Int32, Object, Guid) | Adds 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) | Creates a session. |
|
CreateSession(String, Int32, Object, Guid) | Creates a session. |
|
Equals(Object) | (Inherited from Object.) |
|
Finalize() | (Inherited from Object.) |
|
GetEnumerator() | Gets an enumerator object that can iterate through the sessions. |
|
GetHashCode() | (Inherited from Object.) |
|
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. |
|
GetType() | (Inherited from Object.) |
|
MemberwiseClone() | (Inherited from Object.) |
|
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. |
|
ToString() | (Inherited from Object.) |
Events
Name | Description | |
---|---|---|
SessionCloseEvent | Raised to close the session. |
|
SessionHideEvent | Raised to hide the session. |
|
SessionShowEvent | Raised to show the session. |
Thread Safety
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also
Return to top
Unified Service Desk 2.0
© 2017 Microsoft. All rights reserved. Copyright