AgentDesktopSessions Class

Article
02/21/2017

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2013, Dynamics CRM 2015, Dynamics CRM 2016

Represents the sessions class that is used to create and handle the individual AgentDesktopSessions.

Namespace: Microsoft.Uii.Desktop.SessionManager
Assembly: Microsoft.Uii.Desktop.SessionManager (in Microsoft.Uii.Desktop.SessionManager.dll)

Inheritance Hierarchy

System.Object
Microsoft.Uii.Csr.Sessions
Microsoft.Uii.Desktop.SessionManager.AgentDesktopSessions

Syntax

public class AgentDesktopSessions : Sessions

Public Class AgentDesktopSessions
    Inherits Sessions

Constructors

	Name	Description
	AgentDesktopSessions()	Initializes a new instance of the AgentDesktopSessions class.
	AgentDesktopSessions(Boolean)	Initializes a new instance of the AgentDesktopSessions class.
	AgentDesktopSessions(Boolean, Int32)	Initializes a new instance of the AgentDesktopSessions class.
	AgentDesktopSessions(Boolean, Int32, Boolean)	Initializes a new instance of the AgentDesktopSessions class.

Properties

	Name	Description
	ActiveSession	Gets the currently active session or null.(Inherited from Sessions.)
	Count	The number of current sessions, not counting any global ones.(Inherited from Sessions.)
	GlobalSession	Gets the global session or null.(Inherited from Sessions.)
	Throttled	Gets a Boolean value that specifies whether the sessions have been throttled or not.(Inherited from Sessions.)

Methods

	Name	Description
	AddSession(String, Int32, Object)	Add a new session to the UII desktop.(Inherited from Sessions.)
	AddSession(String, Int32, Object, Guid)	Adds a new session to the UII desktop(Inherited from Sessions.)
	CloseAll()	Closes all sessions.(Inherited from Sessions.)
	CloseSession(Session, Boolean)	Closes the session and if it was the active session, assigns another session to be the active one.(Inherited from Sessions.)
	CreateSession(String, Int32, Object)	Creates a new desktop session object.(Overrides Sessions.CreateSession(String, Int32, Object).)
	CreateSession(String, Int32, Object, Guid)	Creates a new desktop session object(Overrides Sessions.CreateSession(String, Int32, Object, Guid).)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetEnumerator()	Gets an enumerator object that can iterate through the sessions.(Inherited from Sessions.)
	GetHashCode()	(Inherited from Object.)
	GetSession(Guid)	Gets the session based on the sessionID.(Inherited from Sessions.)
	GetSession(Int32)	Gets the session based on the callID.(Inherited from Sessions.)
	GetSession(String)	Gets the session based on the customer ID.(Inherited from Sessions.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	Save()	Saves the sessions and returns an XML giving the state of all existing sessions.(Inherited from Sessions.)
	SetActiveSession(Guid)	Sets the session whose ID is given to be the active one and updates the UI as needed.(Inherited from Sessions.)
	ToString()	(Inherited from Object.)

Events

	Name	Description
	SessionCloseEvent	Raised to close the session.(Inherited from Sessions.)
	SessionHideEvent	Raised to hide the session.(Inherited from Sessions.)
	SessionShowEvent	Raised to show the session.(Inherited from Sessions.)

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.

Share via