AgentDesktopSession Class

Article
11/28/2016

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

Represents a single customer session within the agent desktop.

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

Inheritance Hierarchy

System.Object
Microsoft.Uii.Csr.Session
Microsoft.Uii.Desktop.SessionManager.AgentDesktopSession

Syntax

public class AgentDesktopSession : Session

Public Class AgentDesktopSession
    Inherits Session

Constructors

	Name	Description
	AgentDesktopSession(String, CustomerEntity)	Initializes a new instance of the AgentDesktopSession class.
	AgentDesktopSession(String, CustomerEntity, Guid)	Initializes a new instance of the AgentDesktopSession class.
	AgentDesktopSession(String, Int32, CustomerEntity, Boolean)	Initializes a new instance of the AgentDesktopSession class.

Properties

	Name	Description
	AppHost	Get the list of applications and data for this session.(Inherited from Session.)
	CallId	Gets or sets the ID which identifies the call if there is one for this session. -1 if not.(Inherited from Session.)
	CtiCallRefId	Gets or sets the call reference ID.
	CtiCallRefIdChat	Gets or sets the secondary call reference ID that identifies a second call assocated with the session.
	CtiCallType	Gets or sets the primary call type that describes the session, whether it is an Email / Voice / Chat.
	Customer	Gets or sets the customer object that contains information about the customer.
	FocusedApplication	Gets or sets the application in the session which currently has focus.(Inherited from Session.)
	Global	Gets a bool indicating if this is a global session, that is one that is not tied to a customer.(Inherited from Session.)
	IsWorkflowPending	Gets or sets if the workflow being used (pending). Returns false if no workflow or if its done or cancelled.(Inherited from Session.)
	Name	Gets or sets the name of the session.(Inherited from Session.)
	PresenceState	Gets or sets the setting for the Presense state for this session.(Inherited from Session.)
	RestoredSessionInfo	Implementation for Modified Workflow(Inherited from Session.)
	SessionId	Get the the unique ID for this session.(Inherited from Session.)
	StartTime	Get the start time of the the session.(Inherited from Session.)
	Workflow	Gets or sets the serialized state of the workflow for this session, kept in XML. Used whenever switching sessions to restore the workflow.(Inherited from Session.)

Methods

	Name	Description
	ApplicationExists(Guid)	Returns whether an application exists in this session.(Inherited from Session.)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetApplication(Guid)	Returns the requested application or null if none.(Inherited from Session.)
	GetCustomerID()	Gets the customer ID.(Overrides Session.GetCustomerID().)
	GetEnumerator()	Returns an enumerator that iterates through the collection(Inherited from Session.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	MemberwiseClone()	(Inherited from Object.)
	Restore(String)	Restores the state of a session from the passed PackageSession Object.(Overrides Session.Restore(String).)
	Save(Boolean)	Creates a serialized save version of the session and its associated data in preparation for storage.(Overrides Session.Save(Boolean).)
	ToString()	This method override the default ToString() method.(Inherited from 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.

Share via