HostedApplication Class

Article
02/21/2017

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

Hosted Application abstract base classed, used for hosted application classes like External and Web

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

Inheritance Hierarchy

System.Object
Microsoft.Uii.Csr.HostedApplication
Microsoft.Uii.Csr.ExternalApplication
Microsoft.Uii.Csr.HostedWebApplication

Syntax

public abstract class HostedApplication : IHostedApplication4, 
    IHostedApplication3, IHostedApplication2, IHostedApplication

Public MustInherit Class HostedApplication
    Implements IHostedApplication4, IHostedApplication3, IHostedApplication2,
    IHostedApplication

Constructors

	Name	Description
	HostedApplication()

Properties

	Name	Description
	AgentID	Get or set the agent ID.
	ApplicationID	Get the application ID.
	ApplicationName	Get the application name.
	CanEmbed	Get whether the application can be embedded (is it external?).
	ConfigurationReader	Configuration reader used for reading app settings from application configuration or the server
	DisplayGroup	Get the display group.
	engine	engine
	Icon	Gets or sets the icon used to represent the application in the UII UI.
	ImplementedAsCcf20	Allows system to run certain routines as CCF 2.0 or prior
	IsAdapterSessionController	Gets a boolean indicating whether the adapter is a SessionController.
	IsGlobal	Tells whether the hosted application is global
	IsListed	Allows to be seen but not listed in SessionExplorer or CurrentSessionUI
	IsNavigating	Get whether the application is navigating.
	MinimumSize	Get the hint for the minimum size.
	OptimumSize	Get the hint for the optimum size.
	SessionManager	Allows hosted apps to have access to the session manager object
	TopLevelWindow	Get the top level window.

Methods

	Name	Description
	AddAction(Int32, String, String)	Method to add an action.
	Close()	Close the application.
	CreateInstance(String, String)	Obsolete. Method used to help create Instances of applications / objects
	CreateInstance(String, String, WorkItem)	Method used to help create Instances of applications / objects
	DoAction(Int32, String)	Do an action.
	DoAction(RequestActionEventArgs)	Do an action.
	DoAction(String, String)	Obsolete. Do an action.
	DoDefaultAction()	Default action to fire.
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	FireRequestAction(RequestActionEventArgs)	Sends a request to perform some action to another application. If the RequestActionEventArgs has a target of *, then all apps get the action.
	GetCompiledState(Byte[], Byte[])	Obsolete. Get the compiled State
	GetEventSourceInstance(String, String)	Obsolete. Get the event source instance.
	GetGlobalInstance(String)	Obsolete. Get global instances
	GetHashCode()	(Inherited from Object.)
	GetIconList()	Image list for the application.
	GetStateData()	Request to the hosted app to return its current state.
	GetType()	(Inherited from Object.)
	Initialize()	Called into the application by the framework to allow it to initialize
	IsImplicitAction(String)	Returns true for actions that do not have to be configured
	MemberwiseClone()	(Inherited from Object.)
	Notify(String, Object)	Obsolete. Notify the script with information.
	NotifyContextChange(Context)	Notify the application that the context changed
	NotifyContextChange(String)	Obsolete. Notify the application that the context changed
	OnCompilerError(IVsaError)	Obsolete. On Compiler error
	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.
	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.
	SetContext(String)	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.
	SetStateData(String)	Passes saved state to the hosted application.
	ToString()	(Inherited from Object.)

Fields

	Name	Description
	ScriptObjectName	Hosted Application

Events

	Name	Description
	ActionCompleted	Obsolete. Event fired when the action is complete.
	ActionCompletedEvent	Event to notify ApplicationHost that an action has completed.
	ChangeContext	This event is fired when the context is changed.
	RequestAction	Obsolete. Event fired to request an action.
	RequestActionEvent	Event fired to request an action.
	RequestActionStatusEvent	Event to notify ApplicationHost of action status.

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