Class ExternalApplication

identity

me

• get me(): Identity

• Returns Identity

  Deprecated

  me should only be accessed from the fin global (FinApi.me); access through entity classes is not guaranteed to behave sensibly in all calling contexts.

addListener

• addListener<EventType>(eventType, listener, options?): Promise<ExternalApplication>

• Adds a listener to the end of the listeners array for the specified event.

  Type Parameters

  • EventType extends "connected" | "disconnected"

  Parameters

  • eventType: EventType
  • listener: EventHandler<OpenFin.Events.ExternalApplicationEvents.Event, EventType>
  • Optionaloptions: SubscriptionOptions

  Returns Promise<ExternalApplication>

eventNames

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

• Returns (string | symbol)[]

getInfo

• getInfo(): Promise<ExternalApplicationInfo>

• Retrieves information about the external application.

  Returns Promise<ExternalApplicationInfo>

  Example

  async function getInfo() {
      const extApp = await fin.ExternalApplication.wrap('javaApp-uuid');
      return await extApp.getInfo();
  }
  getInfo().then(info => console.log(info)).catch(err => console.log(err));
  Copy

listenerCount

• listenerCount(type): number

• Parameters

  • type: string | symbol

  Returns number

listeners

• listeners(type): Function[]

• Parameters

  • type: string | symbol

  Returns Function[]

on

• on<EventType>(eventType, listener, options?): Promise<ExternalApplication>

• Adds a listener to the end of the listeners array for the specified event.

  Type Parameters

  • EventType extends "connected" | "disconnected"

  Parameters

  • eventType: EventType
  • listener: EventHandler<OpenFin.Events.ExternalApplicationEvents.Event, EventType>
  • Optionaloptions: SubscriptionOptions

  Returns Promise<ExternalApplication>

  Remarks

  Event payloads are documented in the OpenFin.Events namespace.

once

• once<EventType>(eventType, listener, options?): Promise<ExternalApplication>

• Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed.

  Type Parameters

  • EventType extends "connected" | "disconnected"

  Parameters

  • eventType: EventType
  • listener: EventHandler<OpenFin.Events.ExternalApplicationEvents.Event, EventType>
  • Optionaloptions: SubscriptionOptions

  Returns Promise<ExternalApplication>

  Remarks

  Event payloads are documented in the OpenFin.Events namespace.

prependListener

• prependListener<EventType>(eventType, listener, options?): Promise<ExternalApplication>

• Adds a listener to the beginning of the listeners array for the specified event.

  Type Parameters

  • EventType extends "connected" | "disconnected"

  Parameters

  • eventType: EventType
  • listener: EventHandler<OpenFin.Events.ExternalApplicationEvents.Event, EventType>
  • Optionaloptions: SubscriptionOptions

  Returns Promise<ExternalApplication>

  Remarks

  Event payloads are documented in the OpenFin.Events namespace.

prependOnceListener

• prependOnceListener<EventType>(eventType, listener, options?): Promise<ExternalApplication>

• Adds a one time listener for the event. The listener is invoked only the first time the event is fired, after which it is removed. The listener is added to the beginning of the listeners array.

  Type Parameters

  • EventType extends "connected" | "disconnected"

  Parameters

  • eventType: EventType
  • listener: EventHandler<OpenFin.Events.ExternalApplicationEvents.Event, EventType>
  • Optionaloptions: SubscriptionOptions

  Returns Promise<ExternalApplication>

  Remarks

  Event payloads are documented in the OpenFin.Events namespace.

removeAllListeners

• removeAllListeners(eventType?): Promise<ExternalApplication>

• Removes all listeners, or those of the specified event.

  Parameters

  • OptionaleventType: "connected" | "disconnected"

  Returns Promise<ExternalApplication>

removeListener

• removeListener<EventType>(eventType, listener, options?): Promise<ExternalApplication>

• Remove a listener from the listener array for the specified event.

  Type Parameters

  • EventType extends "connected" | "disconnected"

  Parameters

  • eventType: EventType
  • listener: EventHandler<OpenFin.Events.ExternalApplicationEvents.Event, EventType>
  • Optionaloptions: SubscriptionOptions

  Returns Promise<ExternalApplication>

  Remarks

  Caution: Calling this method changes the array indices in the listener array behind the listener.