Share via


ApplicationAdapter Class

 

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

Represents the abstract class used to create application adapters.

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

Inheritance Hierarchy

System.Object
  Microsoft.Uii.Csr.HostedApplicationAdapter
    Microsoft.Uii.Csr.ApplicationAdapter

Syntax

public abstract class ApplicationAdapter : HostedApplicationAdapter
Public MustInherit Class ApplicationAdapter
    Inherits HostedApplicationAdapter

Constructors

Name Description
System_CAPS_protmethod ApplicationAdapter()

Initializes a new instance of the ApplicationAdapter class.

Properties

Name Description
System_CAPS_pubproperty ApplicationInitString

Gets or sets the XML string used to initialize the application.(Inherited from HostedApplicationAdapter.)

System_CAPS_pubproperty DdaApplicationObject

Gets or sets the application object data-driven adapters used to manipulate the application.(Inherited from HostedApplicationAdapter.)

System_CAPS_pubproperty MainWindowHandle

Gets or sets the handle for the main window. This property is designated for integration purposes, may not be the same as Process.MainWindowHandle

System_CAPS_pubproperty Name

Gets or sets the name of the application that the adapter is working with.(Inherited from HostedApplicationAdapter.)

System_CAPS_pubproperty Process

Gets or sets the external process that UII controls.

System_CAPS_pubproperty SessionID

Gets or sets the ID of the current session. The SessionID is used with global applications to track which session is active.(Inherited from HostedApplicationAdapter.)

System_CAPS_pubproperty SessionWorkItem

Gets or sets the work item that identifies the session.(Inherited from HostedApplicationAdapter.)

Methods

Name Description
System_CAPS_pubmethod AdapterContextChange(Context)

Used by inherited classes to send context change event to UII.(Inherited from HostedApplicationAdapter.)

System_CAPS_pubmethod AdapterFireAction(String, String, String)

Obsolete. Used by inherited classes to request an action through UII to other applications.(Inherited from HostedApplicationAdapter.)

System_CAPS_pubmethod AdapterFireRequestAction(RequestActionEventArgs)

Used by inherited classes to request an action through UII to other applications.(Inherited from HostedApplicationAdapter.)

System_CAPS_pubmethod AdapterProcessChange(Process)

Used by inherited classes to send process change event to UII

System_CAPS_pubmethod Close()

Called when the application this is working with is being closed by the UII application host. This may not run if the application closes itself.(Inherited from HostedApplicationAdapter.)

System_CAPS_pubmethod DoAction(Action, RequestActionEventArgs)

Called by UII whenever an action is about to be performed on the application.(Inherited from HostedApplicationAdapter.)

System_CAPS_pubmethod DoAction(Action, String)

Obsolete. Called by UII whenever an action is about to be performed on the application.(Inherited from HostedApplicationAdapter.)

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod Finalize()

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetStateData(String)

Gets the UII agent's state.(Inherited from HostedApplicationAdapter.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod Initialize()

Initializes the hosted application.(Inherited from HostedApplicationAdapter.)

System_CAPS_protmethod MemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethod NotifyContextChange(Context)

Called when the context is changed.(Inherited from HostedApplicationAdapter.)

System_CAPS_pubmethod NotifyContextChange(String)

Obsolete. Obsolete. Called when the context is changed.(Inherited from HostedApplicationAdapter.)

System_CAPS_pubmethod SessionChange(Boolean, String)

Called by UII whenever the session changes. Only happens for global applications.(Inherited from HostedApplicationAdapter.)

System_CAPS_pubmethod SetStateData(String)

Sets the UII agent's state.(Inherited from HostedApplicationAdapter.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

Events

Name Description
System_CAPS_pubevent AdapterContextChangedEvent

Notifies the UII when the adapter changes the context.(Inherited from HostedApplicationAdapter.)

System_CAPS_pubevent AdapterFireRequestActionEvent

Lets the adapter request that an action be started. This can be used within custom adapters to send UII actions.(Inherited from HostedApplicationAdapter.)

System_CAPS_pubevent AdapterProcessChangedEvent

Notifies UII that the process has been changed, for example, that a new one was spawned. This can be used within custom adapters to notify UII of changes.

System_CAPS_pubevent AdapterRequestActionEvent

Obsolete. Lets the adapter request that an action be fired. This can be used within custom adapters to send UII actions. Obsolete.(Inherited from HostedApplicationAdapter.)

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
Use the UII application adapter

Return to top

Unified Service Desk 2.0

© 2017 Microsoft. All rights reserved. Copyright