Class InteropModule

Manages creation of Interop Brokers and Interop Clients. These APIs are called under-the-hood in Platforms.

Hierarchy

Base
- InteropModule

Index

Accessors

Methods

connectSync init

Accessors

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.

Inherited from Base.me

Methods

connectSync

connectSync(name, interopConfig?): InteropClient
Connects a client to an Interop broker. This is called under-the-hood for Views in a Platform.
Parameters
- name: string
  The name of the Interop Broker to connect to. For Platforms, this will default to the uuid of the Platform.
- OptionalinteropConfig: InteropConfig
  Information relevant to the Interop Broker. Typically a declaration of what context(s) the entity wants to subscribe to, and the current Context Group of the entity.
Returns InteropClient
Remarks
Example
```
const interopConfig = {
    currentContextGroup: 'green'
}

const interopBroker = await fin.Interop.init('openfin');
const client = await fin.Interop.connectSync('openfin', interopConfig);
const contextGroupInfo = await client.getInfoForContextGroup();
console.log(contextGroupInfo);
```

init

init(name, override?): Promise<InteropBroker>
Initializes an Interop Broker. This is called under-the-hood for Platforms.
Parameters
- name: string
  Name of the Interop Broker.
- override: OverrideCallback<InteropBroker, InteropBroker> | ConstructorOverride<InteropBroker>[] = defaultOverride
  A callback function or array of callback functions that can be used to extend or replace default Interop Broker behavior.
Returns Promise<InteropBroker>
Remarks
For Platforms, this is set up automatically. We advise to only create your own Interop Broker when not using a Platform app. You can override functions in the Interop Broker. More info here.

Example
```
const interopBroker = await fin.Interop.init('openfin');
const contextGroups = await interopBroker.getContextGroups();
console.log(contextGroups);
```