Class ExternalApplication

Classdesc

An ExternalApplication object representing native language adapter connections to the runtime. Allows the developer to listen to application events. Discovery of connections is provided by getAllExternalApplications.

Processes that can be wrapped as ExternalApplications include the following:

Processes which have connected to an OpenFin runtime via an adapter
Processes started via System.launchExternalApplication
Processes monitored via System.monitorExternalProcess

Hideconstructor

Hierarchy

EmitterBase<OpenFin.ExternalApplicationEvent>
- ExternalApplication

Index

Constructors

constructor

Properties

addListener identity wire

Accessors

Methods

emit eventNames getInfo listenerCount listeners on once prependListener prependOnceListener removeAllListeners removeListener

Constructors

constructor

new ExternalApplication(wire: Transport<EntityType>, identity: ApplicationIdentity): OpenFin.ExternalApplication
Parameters
- wire: Transport<EntityType>
- identity: ApplicationIdentity
Returns OpenFin.ExternalApplication

Overrides EmitterBase<OpenFin.ExternalApplicationEvent>.constructor

Properties

addListener

addListener: (<EventType>(eventType: EventType, listener: EventHandler<OpenFin.ExternalApplicationEvents.ExternalApplicationEvent, EventType>, options?: SubscriptionOptions) => Promise<OpenFin.ExternalApplication>) = ...

Type declaration

- <EventType>(eventType: EventType, listener: EventHandler<OpenFin.ExternalApplicationEvents.ExternalApplicationEvent, EventType>, options?: SubscriptionOptions): Promise<OpenFin.ExternalApplication>
- Type Parameters
  - EventType extends "connected" | "disconnected"
  Parameters
  - eventType: EventType
  - listener: EventHandler<OpenFin.ExternalApplicationEvents.ExternalApplicationEvent, EventType>
  - Optional options: SubscriptionOptions
  Returns Promise<OpenFin.ExternalApplication>

identity

identity: ApplicationIdentity

wire

wire: Transport<EntityType>

Accessors

me

get me(): Identity
Returns Identity

Inherited from EmitterBase.me

Methods

emit

emit<EventType>(eventType: EventType, payload: Extract<EmitterEvent, {
type: EventType;
}>, ...args: any[]): boolean
Type Parameters
- EventType extends string
Parameters
- eventType: EventType
- payload: Extract<EmitterEvent, {
  type: EventType;
  }>
- Rest ...args: any[]
Returns boolean

Inherited from EmitterBase.emit

eventNames

eventNames(): (string | symbol)[]
Returns (string | symbol)[]

Inherited from EmitterBase.eventNames

getInfo

getInfo(): Promise<ExternalApplicationInfo>
Retrieves information about the external application.

Returns

Tutorial
ExternalApplication.getInfo

Returns Promise<ExternalApplicationInfo>

listenerCount

listenerCount(type: string | symbol): number
Parameters
- type: string | symbol
Returns number

Inherited from EmitterBase.listenerCount

listeners

listeners(type: string | symbol): Function[]
Parameters
- type: string | symbol
Returns Function[]

Inherited from EmitterBase.listeners

on

on<EventType>(eventType: EventType, listener: EventHandler<OpenFin.ExternalApplicationEvents.ExternalApplicationEvent, EventType>, options?: SubscriptionOptions): Promise<OpenFin.ExternalApplication>
Type Parameters
- EventType extends "connected" | "disconnected"
Parameters
- eventType: EventType
- listener: EventHandler<OpenFin.ExternalApplicationEvents.ExternalApplicationEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<OpenFin.ExternalApplication>

Inherited from EmitterBase.on

once

once<EventType>(eventType: EventType, listener: EventHandler<OpenFin.ExternalApplicationEvents.ExternalApplicationEvent, EventType>, options?: SubscriptionOptions): Promise<OpenFin.ExternalApplication>
Type Parameters
- EventType extends "connected" | "disconnected"
Parameters
- eventType: EventType
- listener: EventHandler<OpenFin.ExternalApplicationEvents.ExternalApplicationEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<OpenFin.ExternalApplication>

Inherited from EmitterBase.once

prependListener

prependListener<EventType>(eventType: EventType, listener: EventHandler<OpenFin.ExternalApplicationEvents.ExternalApplicationEvent, EventType>, options?: SubscriptionOptions): Promise<OpenFin.ExternalApplication>
Type Parameters
- EventType extends "connected" | "disconnected"
Parameters
- eventType: EventType
- listener: EventHandler<OpenFin.ExternalApplicationEvents.ExternalApplicationEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<OpenFin.ExternalApplication>

Inherited from EmitterBase.prependListener

prependOnceListener

prependOnceListener<EventType>(eventType: EventType, listener: EventHandler<OpenFin.ExternalApplicationEvents.ExternalApplicationEvent, EventType>, options?: SubscriptionOptions): Promise<OpenFin.ExternalApplication>
Type Parameters
- EventType extends "connected" | "disconnected"
Parameters
- eventType: EventType
- listener: EventHandler<OpenFin.ExternalApplicationEvents.ExternalApplicationEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<OpenFin.ExternalApplication>

Inherited from EmitterBase.prependOnceListener

removeAllListeners

removeAllListeners(eventType?: "connected" | "disconnected"): Promise<OpenFin.ExternalApplication>
Parameters
- Optional eventType: "connected" | "disconnected"
Returns Promise<OpenFin.ExternalApplication>

Inherited from EmitterBase.removeAllListeners

removeListener

removeListener<EventType>(eventType: EventType, listener: EventHandler<OpenFin.ExternalApplicationEvents.ExternalApplicationEvent, EventType>, options?: SubscriptionOptions): Promise<OpenFin.ExternalApplication>
Type Parameters
- EventType extends "connected" | "disconnected"
Parameters
- eventType: EventType
- listener: EventHandler<OpenFin.ExternalApplicationEvents.ExternalApplicationEvent, EventType>
- Optional options: SubscriptionOptions
Returns Promise<OpenFin.ExternalApplication>

Inherited from EmitterBase.removeListener

Class ExternalApplication

Classdesc

Hideconstructor

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

wire: Transport<EntityType>

identity: ApplicationIdentity

Returns OpenFin.ExternalApplication

Properties

addListener

Type declaration

Type Parameters

EventType extends "connected" | "disconnected"

Parameters

eventType: EventType

listener: EventHandler<OpenFin.ExternalApplicationEvents.ExternalApplicationEvent, EventType>

Optional options: SubscriptionOptions

Returns Promise<OpenFin.ExternalApplication>

identity

wire

Accessors

me

Returns Identity

Methods

emit

Type Parameters

EventType extends string

Parameters

eventType: EventType

payload: Extract<EmitterEvent, { type: EventType; }>

Rest ...args: any[]

Returns boolean

eventNames

Returns (string | symbol)[]

getInfo

Returns

Tutorial

Returns Promise<ExternalApplicationInfo>

listenerCount

Parameters

type: string | symbol

Returns number

listeners

Parameters

type: string | symbol

Returns Function[]

on

Type Parameters

EventType extends "connected" | "disconnected"

Parameters

eventType: EventType

listener: EventHandler<OpenFin.ExternalApplicationEvents.ExternalApplicationEvent, EventType>

Optional options: SubscriptionOptions

Returns Promise<OpenFin.ExternalApplication>

once

Type Parameters

EventType extends "connected" | "disconnected"

Parameters

eventType: EventType

listener: EventHandler<OpenFin.ExternalApplicationEvents.ExternalApplicationEvent, EventType>

Optional options: SubscriptionOptions

Returns Promise<OpenFin.ExternalApplication>

prependListener

Type Parameters

EventType extends "connected" | "disconnected"

Parameters

eventType: EventType

listener: EventHandler<OpenFin.ExternalApplicationEvents.ExternalApplicationEvent, EventType>

Optional options: SubscriptionOptions

Returns Promise<OpenFin.ExternalApplication>

prependOnceListener

Type Parameters

EventType extends "connected" | "disconnected"

`Optional` options: SubscriptionOptions

payload: Extract<EmitterEvent, {
type: EventType;
}>

`Rest` ...args: any[]

`Optional` options: SubscriptionOptions

`Optional` options: SubscriptionOptions

`Optional` options: SubscriptionOptions

`Optional` options: SubscriptionOptions

`Optional` eventType: "connected" | "disconnected"

`Optional` options: SubscriptionOptions