ExternalApplication Class

  • Статья

 

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

Contains information that is used to integrate an external application with UII.

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

Syntax

[SmartPartAttribute]
public class ExternalApplication : HostedApplication

<SmartPartAttribute>
Public Class ExternalApplication
    Inherits HostedApplication

Constructors

Name Description
System_CAPS_pubmethod ExternalApplication(Guid, String, String)

Constructor when creating an external application hosted within or by UII.

Properties

Name Description
System_CAPS_pubproperty AgentID

Get or set the agent ID.(Inherited from HostedApplication.)
System_CAPS_pubproperty AmbientProperties

Gets the set of ambient properties for an application.
System_CAPS_pubproperty AppHostWorkItem

Sets the current work item
System_CAPS_pubproperty Application

Gets or sets the application object for scripting.
System_CAPS_protproperty ApplicationHost

Gets or sets the application host.
System_CAPS_pubproperty ApplicationID

Gets the unique ID for the application as given in the database.(Overrides HostedApplication.ApplicationID.)
System_CAPS_pubproperty ApplicationInitializationXml

XML from the database that is used to configure the application in case this class is inherited and the init information is needed.
System_CAPS_pubproperty ApplicationName

Name of this hosted application.(Overrides HostedApplication.ApplicationName.)
System_CAPS_protproperty applicationObject

Application Object. This is the main window handle
System_CAPS_protproperty AssemblyUrl

Extracted from //interopAssembly/URL of the application initstring.
System_CAPS_pubproperty CanEmbed

Gets a Boolean value that specifies whether the application can be embedded.(Overrides HostedApplication.CanEmbed.)
System_CAPS_pubproperty ConfigurationReader

Configuration reader used for reading app settings from application configuration or the server(Inherited from HostedApplication.)
System_CAPS_pubproperty Context

Gets and Sets the context for the hosted applications.
System_CAPS_pubproperty DisplayGroup

Get the display group.(Overrides HostedApplication.DisplayGroup.)
System_CAPS_protproperty engine

engine(Inherited from HostedApplication.)
System_CAPS_protproperty ExternalControl

An instance of ExternalControl that is managing the execution of the hosted external application.
System_CAPS_pubproperty HostedApplicationAdapter

Application adapter instance for the external application, when configured. For Internal Use.
System_CAPS_pubproperty HostInside

Gets whether the hosted application window is managed by UII.
System_CAPS_pubproperty Icon

Used to indicate the preferred icon to use(Overrides HostedApplication.Icon.)
System_CAPS_pubproperty ImplementedAsCcf20

Allows system to run certain routines as CCF 2.0 or prior.(Overrides HostedApplication.ImplementedAsCcf20.)
System_CAPS_pubproperty IsAdapterSessionController

Gets a boolean indicating whether the adapter is a SessionController.(Inherited from HostedApplication.)
System_CAPS_pubproperty IsDynamic

Gets or sets a value indicating whether this instance is dynamic.
System_CAPS_pubproperty IsGlobal

Tells whether the hosted application is global scoped.(Overrides HostedApplication.IsGlobal.)
System_CAPS_pubproperty IsListed

Allows to be seen but not listed in SessionExplorer or CurrentSessionUI.(Overrides HostedApplication.IsListed.)
System_CAPS_pubproperty IsNavigating

Could be used to indicate this hosted application is changing state.(Overrides HostedApplication.IsNavigating.)
System_CAPS_pubproperty IsTagged

When true, application is dependent on workflow
System_CAPS_protproperty LoadScriptActionData

Action data capture prior to LoadScript()
System_CAPS_pubproperty MinimumSize

Not used in CCF 1.02(Overrides HostedApplication.MinimumSize.)
System_CAPS_pubproperty OptimumSize

Initial size of the hosted application window if HostInside=false.(Overrides HostedApplication.OptimumSize.)
System_CAPS_pubproperty Parent

The Windows Forms Control which is parenting this application.
System_CAPS_protproperty Process

Process object representing the process of the hosted external application.
System_CAPS_pubproperty SessionManager

Allows hosted applications to have access to the session manager object.(Overrides HostedApplication.SessionManager.)
System_CAPS_pubproperty TopLevelWindow

The Windows Forms Control this hosted application resides in.(Overrides HostedApplication.TopLevelWindow.)

Methods

Name Description
System_CAPS_protmethod adapter_AdapterContextChangedEvent(Context)

Event handler which is run when an adapter needs to notify UII of new context information.
System_CAPS_protmethod adapter_AdapterFireRequestActionEvent(RequestActionEventArgs)

Used when an adapter requests that an action be done on an application.
System_CAPS_protmethod adapter_AdapterProcessChangedEvent(Process)

Event handler which is run when an adapter needs to notify UII of a process change.
System_CAPS_protmethod adapter_AdapterRequestActionEvent(String, String, String)

Used when an adapter requests that an action be done on an application.
System_CAPS_pubmethod AddAction(Int32, String, String)

Adds an action to the application's list. An action with id == 1 is the 'default' action and gets called on init. There does not need to be a default action though, just don't have an action with id 1 if you don't want a default.(Overrides HostedApplication.AddAction(Int32, String, String).)
System_CAPS_pubmethod Close()

Called when the hosting framework wishes to close this application.(Overrides HostedApplication.Close().)
System_CAPS_protmethod CreateInstance(String, String)

Obsolete. Method used to help create Instances of applications / objects(Inherited from HostedApplication.)
System_CAPS_protmethod CreateInstance(String, String, WorkItem)

Method used to help create Instances of applications / objects(Inherited from HostedApplication.)
System_CAPS_pubmethod DoAction(Int32, String)

Performs an action where the action is specified by its ID.(Overrides HostedApplication.DoAction(Int32, String).)
System_CAPS_protmethod DoAction(RequestActionEventArgs)

Performs an action where the action is given by the RequestActionEventArgs.(Overrides HostedApplication.DoAction(RequestActionEventArgs).)
System_CAPS_pubmethod DoAction(String, String)

Obsolete. Performs an action where the action is given by its unique name.(Overrides HostedApplication.DoAction(String, String).)
System_CAPS_pubmethod DoDefaultAction()

Performs the default action on the application, if there is a default action. The default action is the one with an id of 1, but there may not be one.(Overrides HostedApplication.DoDefaultAction().)
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)
System_CAPS_protmethod Finalize()

(Inherited from Object.)
System_CAPS_pubmethod FireRequestAction(RequestActionEventArgs)

Additional public members to expose data and events to scripts(Overrides HostedApplication.FireRequestAction(RequestActionEventArgs).)
System_CAPS_pubmethod Focus()

Gives the focus to the hosted Win32 application
System_CAPS_pubmethod GetCompiledState(Byte[], Byte[])

Obsolete. Get the compiled State(Inherited from HostedApplication.)
System_CAPS_pubmethod GetContextValue(String)

Returns the value associated with the provided context key. If the key is not found, the empty string will be returned. If no reference to the Context object is held, null will be returned.
System_CAPS_pubmethod GetEventSourceInstance(String, String)

Obsolete. Get the event source instance.(Inherited from HostedApplication.)
System_CAPS_pubmethod GetGlobalInstance(String)

Obsolete. Get global instances(Inherited from HostedApplication.)
System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)
System_CAPS_pubmethod GetIconList()

(Overrides HostedApplication.GetIconList().)
System_CAPS_pubmethod GetStateData()

Gets the application state data for this application For now we retrieve only the ambient properties and context value(Overrides HostedApplication.GetStateData().)
System_CAPS_pubmethod GetType()

(Inherited from Object.)
System_CAPS_pubmethod HandleRequestAction(Object, RequestActionEventArgs)

This is for internal UII use only. Please do not use directly. Public visibility necessary for CAB integration.
System_CAPS_pubmethod HandleRequestDefaultAction(Object, DataEventArgs<ApplicationProperties>)

This is for internal UII use only. Please do not use directly. Public visibility necessary for CAB integration.
System_CAPS_pubmethod Initialize()

Called by the framework when it is ready for the application to initialize itself.(Overrides HostedApplication.Initialize().)
System_CAPS_protmethod loadAdapter(XmlDocument)

Loads an adapter (if any) to modify the application behavior.
System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)
System_CAPS_pubmethod Notify(String, Object)

Obsolete. Notify the script with information.(Inherited from HostedApplication.)
System_CAPS_pubmethod NotifyContextChange(Context)

Notify the application that the context changed(Overrides HostedApplication.NotifyContextChange(Context).)
System_CAPS_pubmethod NotifyContextChange(String)

Obsolete. Called by application host to notify the app that the context has changed(Overrides HostedApplication.NotifyContextChange(String).)
System_CAPS_pubmethod OnCompilerError(IVsaError)

Obsolete. On Compiler error(Inherited from HostedApplication.)
System_CAPS_pubmethod SessionChange(Boolean, Guid)

Called for global applications when the session is activated or deactivated(Overrides HostedApplication.SessionChange(Boolean, Guid).)
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.(Overrides HostedApplication.SetContext(Context).)
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 otherwords, a race condition.(Overrides HostedApplication.SetContext(String).)
System_CAPS_pubmethod SetStateData(String)

Set the application to the state provided in the xml string.(Overrides HostedApplication.SetStateData(String).)
System_CAPS_pubmethod ToString()

(Inherited from Object.)
System_CAPS_pubmethod UpdateContextValue(Dictionary<String, String>)

Accepts a Dictionary collection of keys and values and adds them (or updates it if it currently exists) to the current context. Then notify other apps the context has changed.
System_CAPS_pubmethod UpdateContextValue(String, String)

Accepts a name and value pair and adds it (or updates it if it currently exists) to the current context. Then notify other apps the context has changed. The caller is NO LONGER responsible for notifying other apps of the context change via this.ChangeContext().

Fields

Name Description
System_CAPS_protfield actions

Specifies the dictionary of associated actions.
System_CAPS_protfield actionsByID

Specifies the dictionary of associated actions by action ID.
System_CAPS_protfield applicationType

Specifies the hosted application type.

Events

Name Description
System_CAPS_pubevent ActionCompleted

Obsolete. Event to notify AppHost that an action has completed(Overrides HostedApplication.ActionCompleted.)
System_CAPS_pubevent ActionCompletedEvent

Event to notify ApplicationHost that an action has completed. Using CAB's EventBroker to publish the event topic.(Overrides HostedApplication.ActionCompletedEvent.)
System_CAPS_pubevent ChangeContext

Event to add a name-value pair to the context(Overrides HostedApplication.ChangeContext.)
System_CAPS_pubevent RequestAction

Obsolete. Event to request an action of another application to be invoked(Overrides HostedApplication.RequestAction.)
System_CAPS_pubevent RequestActionEvent

Event publication for event to request an action of another application to be invoked. Using CAB's EventBroker to publish the event topic(Overrides HostedApplication.RequestActionEvent.)
System_CAPS_pubevent RequestActionStatusEvent

Event to notify ApplicationHost of action status.(Overrides HostedApplication.RequestActionStatusEvent.)

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