Share via


IHostedApplication Interface

 

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

Interface from which hosted applications are derived.

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

Syntax

public interface IHostedApplication
Public Interface IHostedApplication

Properties

Name Description
System_CAPS_pubproperty ApplicationID

Gets the application ID.

System_CAPS_pubproperty ApplicationName

Gets the application name.

System_CAPS_pubproperty CanEmbed

Gets a Boolean value that specifies whether the application is an external application.

System_CAPS_pubproperty DisplayGroup

Gets the display group extracted from the initialization string.

System_CAPS_pubproperty IsNavigating

Get a Boolean value that specifies whether the application is currently navigating.

System_CAPS_pubproperty MinimumSize

Gets a hint for minimum window size.

System_CAPS_pubproperty OptimumSize

Gets a hint for optimal window size.

System_CAPS_pubproperty TopLevelWindow

Gets the top level window for the application.

Methods

Name Description
System_CAPS_pubmethod AddAction(Int32, String, String)

Adds an action to the application.

System_CAPS_pubmethod Close()

Closes the application.

System_CAPS_pubmethod DoAction(Int32, String)

Invokes an action on the application

System_CAPS_pubmethod DoAction(String, String)

Obsolete. Invokes an action on the application

System_CAPS_pubmethod DoDefaultAction()

Invokes the default action for the application

System_CAPS_pubmethod GetIconList()

Gets the image list for the application.

System_CAPS_pubmethod GetStateData()

Requests the hosted application to return its current state.

System_CAPS_pubmethod Initialize()

Initializes the hosted application.

System_CAPS_pubmethod NotifyContextChange(String)

Obsolete. Notifies the application that context has changed.

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 SetStateData(String)

Passes the saved state to the hosted application.

Events

Name Description
System_CAPS_pubevent ActionCompleted

Event to notify the hosted application that the action has completed.

System_CAPS_pubevent ChangeContext

Event to add a name-value pair to the context.

System_CAPS_pubevent RequestAction

Event to request an action of another application to be invoked.

Remarks

Use IHostedApplication4 for new implementations.

See Also

Microsoft.Uii.Csr Namespace

Return to top

Unified Service Desk 2.0

© 2017 Microsoft. All rights reserved. Copyright