Global

Type Definitions

FinsembleDependency

A dependency object.

Properties:
Name Type Description
services Array.<string>

List of services required to be ready before callback is invoked.

clients Array.<string>

list of clients required to be ready before callback is invoked.

LinkerChannelsCB
(err, channels)
clients/linkerClient.js, line 763

Callback that returns a list of channels in the responseMessage

Name Type Description
err Object

Error message, or null if no error

channels Array.<string>

List of channels

LinkerState
(channels, allChannels)
clients/linkerClient.js, line 778

A list of enabled channels and a list of all channels

Name Type Description
channels Array.<string>

List of all channels linked to the requested component

allChannels Array.<string>

List of all available channels

LinkerStateCB
(err, channels, allChannels)
clients/linkerClient.js, line 770

Callback that returns a new LinkerState

Name Type Description
err Object

Error message, or null if no error

channels Array.<string>

List of all channels linked to the requested component

allChannels Array.<string>

List of all available channels

RawWindowResult

A convenient assembly of native JavaScript window, OpenFin window and windowDescriptor.

Properties:
Name Type Description
windowDescriptor WindowDescriptor

The window descriptor.

finWindow fin.desktop.Window

The OpenFin window.

browserWindow Window

The native JavaScript window.

WindowDescriptor

Finsemble windowDescriptor. This is a superset of the Openfin windowOptions object. In addition to the values provided by OpenFin, the windowDescriptor includes the following values.

Properties:
Name Type Argument Description
url string <optional>

url to load (if HTML5 component).

native string <optional>

The name of the native app (if a native component launched by Assimilation service).

name string

The name of the window (sometimes randomly assigned).

componentType string

The type of component (from components.json).

WindowIdentifier

An object that includes all the potential identifications for a window. For instance, one can try and obtain a reference for a window if some of these values are known.

Properties:
Name Type Argument Description
windowName string <optional>

The name of the physical OpenFin window, or a reference to a native window that was launched with Assimilation service

uuid string <optional>

Optional uuid of a particular OpenFin application process

componentType string <optional>

The type of component

monitor number | string <optional>

The number of the monitor. Potentially used to disambiguate multiple components with the same name (for searches only)