HostedApplication Class

 

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
System_CAPS_protmethod HostedApplication()

Properties

Name Description
System_CAPS_pubproperty AgentID

Get or set the agent ID.

System_CAPS_pubproperty ApplicationID

Get the application ID.

System_CAPS_pubproperty ApplicationName

Get the application name.

System_CAPS_pubproperty CanEmbed

Get whether the application can be embedded (is it external?).

System_CAPS_pubproperty ConfigurationReader

Configuration reader used for reading app settings from application configuration or the server

System_CAPS_pubproperty DisplayGroup

Get the display group.

System_CAPS_protproperty engine

engine

System_CAPS_pubproperty Icon

Gets or sets the icon used to represent the application in the UII UI.

System_CAPS_pubproperty ImplementedAsCcf20

Allows system to run certain routines as CCF 2.0 or prior

System_CAPS_pubproperty IsAdapterSessionController

Gets a boolean indicating whether the adapter is a SessionController.

System_CAPS_pubproperty IsGlobal

Tells whether the hosted application is global

System_CAPS_pubproperty IsListed

Allows to be seen but not listed in SessionExplorer or CurrentSessionUI

System_CAPS_pubproperty IsNavigating

Get whether the application is navigating.

System_CAPS_pubproperty MinimumSize

Get the hint for the minimum size.

System_CAPS_pubproperty OptimumSize

Get the hint for the optimum size.

System_CAPS_pubproperty SessionManager

Allows hosted apps to have access to the session manager object

System_CAPS_pubproperty TopLevelWindow

Get the top level window.

Methods

Name Description
System_CAPS_pubmethod AddAction(Int32, String, String)

Method to add an action.

System_CAPS_pubmethod Close()

Close the application.

System_CAPS_protmethod CreateInstance(String, String)

Obsolete. Method used to help create Instances of applications / objects

System_CAPS_protmethod CreateInstance(String, String, WorkItem)

Method used to help create Instances of applications / objects

System_CAPS_pubmethod DoAction(Int32, String)

Do an action.

System_CAPS_protmethod DoAction(RequestActionEventArgs)

Do an action.

System_CAPS_pubmethod DoAction(String, String)

Obsolete. Do an action.

System_CAPS_pubmethod DoDefaultAction()

Default action to fire.

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod 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.

System_CAPS_pubmethod GetCompiledState(Byte[], Byte[])

Obsolete. Get the compiled State

System_CAPS_pubmethod GetEventSourceInstance(String, String)

Obsolete. Get the event source instance.

System_CAPS_pubmethod GetGlobalInstance(String)

Obsolete. Get global instances

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetIconList()

Image list for the application.

System_CAPS_pubmethod GetStateData()

Request to the hosted app to return its current state.

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod Initialize()

Called into the application by the framework to allow it to initialize

System_CAPS_pubmethodSystem_CAPS_static IsImplicitAction(String)

Returns true for actions that do not have to be configured

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod Notify(String, Object)

Obsolete. Notify the script with information.

System_CAPS_pubmethod NotifyContextChange(Context)

Notify the application that the context changed

System_CAPS_pubmethod NotifyContextChange(String)

Obsolete. Notify the application that the context changed

System_CAPS_pubmethod OnCompilerError(IVsaError)

Obsolete. On Compiler error

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.

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.

System_CAPS_pubmethod 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.

System_CAPS_pubmethod SetStateData(String)

Passes saved state to the hosted application.

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Fields

Name Description
System_CAPS_protfieldSystem_CAPS_static ScriptObjectName

Hosted Application

Events

Name Description
System_CAPS_pubevent ActionCompleted

Obsolete. Event fired when the action is complete.

System_CAPS_pubevent ActionCompletedEvent

Event to notify ApplicationHost that an action has completed.

System_CAPS_pubevent ChangeContext

This event is fired when the context is changed.

System_CAPS_pubevent RequestAction

Obsolete. Event fired to request an action.

System_CAPS_pubevent RequestActionEvent

Event fired to request an action.

System_CAPS_pubevent 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.

See Also

Microsoft.Uii.Csr Namespace

Return to top

Unified Service Desk 2.0

© 2017 Microsoft. All rights reserved. Copyright