Session Class

 

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

This represents a single customer session within UII An enumeration over a session give a set of IHostedApplications.

Namespace:   Microsoft.Uii.Csr
Assembly:  Microsoft.Uii.Csr.Core (in Microsoft.Uii.Csr.Core.dll)

Inheritance Hierarchy

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

Syntax

public abstract class Session : IEnumerable
Public MustInherit Class Session
    Implements IEnumerable

Constructors

Name Description
System_CAPS_protmethod Session(String, Int32)

Session constructor.

System_CAPS_protmethod Session(String, Int32, Guid)

Session constructor.

System_CAPS_protmethod Session(String, Int32, Guid, Boolean)

Session constructor.

Properties

Name Description
System_CAPS_pubproperty AppHost

Get the list of applications and data for this session.

System_CAPS_pubproperty CallId

Gets or sets the ID which identifies the call if there is one for this session. -1 if not.

System_CAPS_pubproperty FocusedApplication

Gets or sets the application in the session which currently has focus.

System_CAPS_pubproperty Global

Gets a bool indicating if this is a global session, that is one that is not tied to a customer.

System_CAPS_pubproperty IsWorkflowPending

Gets or sets if the workflow being used (pending). Returns false if no workflow or if its done or cancelled.

System_CAPS_pubproperty Name

Gets or sets the name of the session.

System_CAPS_pubproperty PresenceState

Gets or sets the setting for the Presense state for this session.

System_CAPS_pubproperty RestoredSessionInfo

Implementation for Modified Workflow

System_CAPS_pubproperty SessionId

Get the the unique ID for this session.

System_CAPS_pubproperty StartTime

Get the start time of the the session.

System_CAPS_pubproperty Workflow

Gets or sets the serialized state of the workflow for this session, kept in XML. Used whenever switching sessions to restore the workflow.

Methods

Name Description
System_CAPS_pubmethod ApplicationExists(Guid)

Returns whether an application exists in this session.

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetApplication(Guid)

Returns the requested application or null if none.

System_CAPS_pubmethod GetCustomerID()

This abstract method is used to return the customer ID.

System_CAPS_pubmethod GetEnumerator()

Returns an enumerator that iterates through the collection

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod Restore(String)

Restores the state of a session from the passed XML.

System_CAPS_pubmethod Save(Boolean)

Function to save the sessions state for a customer

System_CAPS_pubmethod ToString()

This method override the default ToString() method.(Overrides Object.ToString().)

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

Microsoft.Uii.Csr Namespace

Return to top

Unified Service Desk 2.0

© 2016 Microsoft. All rights reserved. Copyright