Desktop Class

The CcfDesktop class wraps all core CCF functions. The class is provided implement CCF Desktops in an environment. Though it contains all core CCF functions, it should not be invoked directly; rather the class should be used as a base class for custom IAD implementation.

The following figure shows the structure of the class:

The class has the following methods:

Method	Description
AddCcfpanel	Adds a panel to the CCF desktop.
AddSession	Adds a session to the CCF desktop
AfterAddSession	Runs after the session is added.
AfterInitilizedCoreInterfaces	Runs after the close interface is initialized.
AfterSessionCloseEvent	Runs after the session is closed.
AfterSessionHideEvent	Runs after the session is hidden.
AfterSessionShowEvent	Runs after the session is made visible.
AfterWorkflowStartedEvent	Runs after the workflow starts.
AfterWorkflowStatusChange	Runs when a workflow’s status changes.
AppExistsInUI	Returns if the passed application exists in the UI.
BeforeApplicationCreate	Runs before an application is created.
BeforeDesktopClose	Runs before the CCF desktop is closed.
BeforeSessionCloseEvent	Runs before a CCF session is closed.
CcfDesktop	Constructor to create a CCF desktop
CloseSession	Closes the session passed.
DesktopIadInit
DoDynamicAppCreate	Creates a dynamic application.
DynamicApplicationClosed	Returns if the passed dynamic application in the CCF desktop is closed.
DynamicApplicationCreated	Runs if the passed dynamic application is created.
FocusedApplicationUpdated
GetApplicationAdapterFromIHostedApplication
GetApplicationByName	Lists the applications for an interface.
GetCurrentWorkflowState	Returns the passed workflow’s current state.
LoadUserDefinedGlobalApps	Loads the global applications defined by the user.
OnAddHostedApplicationToSession
RemoveCcfPanel	Removes the panel passed from the CCF desktop
SetFocusOnApplication	Requests the desktop to set focus on the current application.
UserDefinedCommand	Passes commands to the desktop from a hosted control outside of the action system.

The class has the following properties:

Property	Description
AgentDesktopID	Holds the ID of the IAD after registration.
AgentDetails	Holds the agent details.
AgentID	Holds the ID of the agent.
AppHost	Contains the ID of the hosted control.
AppsUI
CcfAgentStateSvc
EnableSaveSession
MaxNumberOfSessionsPermitted	Contains the maximum number of sessions permitted to run in the CCF desktop.

The class has the following events:

Event	Description
CcfLoaderAppLoadingStatusUpdated
CcfLoaderComplete
CcfLoaderStatusUpdated