Share via

ISessionExplorer Interface

  • Article

 

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

Describes a Hosted control that will act as a Session Explorer. Used to allow SessionExplorer hosted control interact with the Agent Desktop more directly.

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

Syntax

public interface ISessionExplorer : IHostedApplication3, IHostedApplication2, 
    IHostedApplication

Public Interface ISessionExplorer
    Inherits IHostedApplication3, IHostedApplication2, IHostedApplication

Properties

Name Description
System_CAPS_pubproperty AgentID

Gets or sets the agent who is logged in.(Inherited from IHostedApplication3.)
System_CAPS_pubproperty ApplicationID

Gets the application ID.(Inherited from IHostedApplication.)
System_CAPS_pubproperty ApplicationName

Gets the application name.(Inherited from IHostedApplication.)
System_CAPS_pubproperty AppsUI

Sets the AppsUI value.
System_CAPS_pubproperty CanEmbed

Gets a Boolean value that specifies whether the application is an external application.(Inherited from IHostedApplication.)
System_CAPS_pubproperty ControlHeight

Gets or sets the height of the control.
System_CAPS_pubproperty DisplayGroup

Gets the display group extracted from the initialization string.(Inherited from IHostedApplication.)
System_CAPS_pubproperty Icon

Gets or sets the icon used to represent the application in the UII UI.(Inherited from IHostedApplication2.)
System_CAPS_pubproperty ImplementedAsCcf20

Gets a Boolean value that specifies whether the application is allowed to run certain routines as CCF 2.0 or prior.(Inherited from IHostedApplication3.)
System_CAPS_pubproperty IsControlVisible

Gets or sets the Boolean value that specifies whether the control is displayed.
System_CAPS_pubproperty IsGlobal

Gets or sets a Boolean value that specifies whether the hosted application is global.(Inherited from IHostedApplication3.)
System_CAPS_pubproperty IsListed

Gets a Boolean value that specifies whether the application is allowed to be seen but not listed.(Inherited from IHostedApplication3.)
System_CAPS_pubproperty IsNavigating

Get a Boolean value that specifies whether the application is currently navigating.(Inherited from IHostedApplication.)
System_CAPS_pubproperty MinimumSize

Gets a hint for minimum window size.(Inherited from IHostedApplication.)
System_CAPS_pubproperty OptimumSize

Gets a hint for optimal window size.(Inherited from IHostedApplication.)
System_CAPS_pubproperty SessionManager

Sets the session manager object.(Inherited from IHostedApplication3.)
System_CAPS_pubproperty TopLevelWindow

Gets the top level window for the application.(Inherited from IHostedApplication.)

Methods

Name Description
System_CAPS_pubmethod AddAction(Int32, String, String)

Adds an action to the application.(Inherited from IHostedApplication.)
System_CAPS_pubmethod AddApplicationNode(Session, IHostedApplication)

Adds a single application node.
System_CAPS_pubmethod AddSession(Session, Boolean)

Adds the session to the tree control if it’s not already there.
System_CAPS_pubmethod AddWorkflowApplicationNodes(Session, Boolean)

Adds the application nodes back to sessionexplorer.
System_CAPS_pubmethod Close()

Closes the application.(Inherited from IHostedApplication.)
System_CAPS_pubmethod ControlRefresh()

Forces the control to invalidate its client area and immediately redraw itself and any child controls.
System_CAPS_pubmethod DoAction(Int32, String)

Invokes an action on the application(Inherited from IHostedApplication.)
System_CAPS_pubmethod DoAction(String, String)

Obsolete. Invokes an action on the application(Inherited from IHostedApplication.)
System_CAPS_pubmethod DoDefaultAction()

Invokes the default action for the application(Inherited from IHostedApplication.)
System_CAPS_pubmethod FireRequestAction(RequestActionEventArgs)

Sends a request to perform some action to another application. If the RequestActionEventArgs has a target of *, then all applications get the action.(Inherited from IHostedApplication3.)
System_CAPS_pubmethod FocusOnApplication(IHostedApplication)

Select the given application's node in the treeview.
System_CAPS_pubmethod GetIconList()

Gets the image list for the application.(Inherited from IHostedApplication.)
System_CAPS_pubmethod GetStateData()

Requests the hosted application to return its current state.(Inherited from IHostedApplication.)
System_CAPS_pubmethod Initialize()

Initializes the hosted application.(Inherited from IHostedApplication.)
System_CAPS_pubmethod NotifyContextChange(Context)

Notifies the application that the context has changed.(Inherited from IHostedApplication3.)
System_CAPS_pubmethod NotifyContextChange(String)

Obsolete. Notifies the application that context has changed.(Inherited from IHostedApplication.)
System_CAPS_pubmethod RefreshView()

Completes a redraw of the session explorer UI.
System_CAPS_pubmethod RemoveApplicationNode(Session, IHostedApplication)

Removes a single application node from the session explorer.
System_CAPS_pubmethod RemoveSession(Session)

Removes a session from the session explorer tree.
System_CAPS_pubmethod RemoveWorkflowApplicationNodes(Session)

Removes the applications for a session from the SessionExplorerControl
System_CAPS_pubmethod SessionChange(Boolean, Guid)

Called whenever the session is changed. Only global applications receive this since 'local' applications don't need to know if their session is shown or not.(Inherited from IHostedApplication.)
System_CAPS_pubmethod SetContext(Context)

Obsolete. This is used to set the context from ApplicationHost without causing further notifications. It exists so that context can be updated quietly before doing the 'real' context notification because some applications fire actions onto other apps when the context changes and some actions are designed to depend upon context. In other words, a race condition.(Inherited from IHostedApplication3.)
System_CAPS_pubmethod SetContext(String)

Obsolete. Sets the context from ApplicationHost without causing further notifications. It exists so that context can be updated quietly before doing the 'real' context notification because some applications fire actions onto other apps when the context changes and some actions are designed to depend upon context. In other words, a race condition.(Inherited from IHostedApplication2.)
System_CAPS_pubmethod SetStateData(String)

Passes the saved state to the hosted application.(Inherited from IHostedApplication.)

Events

Name Description
System_CAPS_pubevent ActionCompleted

Event to notify the hosted application that the action has completed.(Inherited from IHostedApplication.)
System_CAPS_pubevent ChangeContext

Event to add a name-value pair to the context.(Inherited from IHostedApplication.)
System_CAPS_pubevent RequestAction

Event to request an action of another application to be invoked.(Inherited from IHostedApplication.)
System_CAPS_pubevent SEHostedAppSelected

Raised when a hosted application is selected.
System_CAPS_pubevent SessionClosed

Raised when a session is closed.

See Also

Microsoft.Uii.Desktop.Core Namespace

Return to top

Unified Service Desk 2.0

© 2017 Microsoft. All rights reserved. Copyright