Share via


HostedApplicationAdapter Class

Definition

Abstract class used by User Interface Integration (UII) developers to create custom adapters for external applications.

public ref class HostedApplicationAdapter abstract
public abstract class HostedApplicationAdapter
type HostedApplicationAdapter = class
Public MustInherit Class HostedApplicationAdapter
Inheritance
HostedApplicationAdapter
Derived

Constructors

HostedApplicationAdapter()

Initializes a new instance of the HostedApplicationAdapter class.

Properties

ApplicationInitString

Gets or sets the XML string used to initialize the application.

DdaApplicationObject

Gets or sets the application object data-driven adapters used to manipulate the application.

Name

Gets or sets the name of the application that the adapter is working with.

SessionID

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

SessionWorkItem

Gets or sets the work item that identifies the session.

Methods

AdapterContextChange(Context)

Used by inherited classes to send context change event to UII.

AdapterFireAction(String, String, String)
Obsolete.

Used by inherited classes to request an action through UII to other applications.

AdapterFireRequestAction(RequestActionEventArgs)

Used by inherited classes to request an action through UII to other applications.

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.

DoAction(Action, RequestActionEventArgs)

Called by UII whenever an action is about to be performed on the application.

DoAction(Action, String)
Obsolete.

Called by UII whenever an action is about to be performed on the application.

GetStateData(String)

Gets the UII agent's state.

Initialize()

Initializes the hosted application.

NotifyContextChange(Context)

Called when the context is changed.

NotifyContextChange(String)
Obsolete.

Obsolete. Called when the context is changed.

SessionChange(Boolean, String)

Called by UII whenever the session changes. Only happens for global applications.

SetStateData(String)

Sets the UII agent's state.

Events

AdapterContextChangedEvent

Notifies the UII when the adapter changes the context.

AdapterFireRequestActionEvent

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

AdapterRequestActionEvent
Obsolete.

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

Applies to