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

Namespace

Alias

Interop

Hierarchy

  • Base
    • InteropModule

Constructors

Properties

Accessors

Methods

Constructors

Properties

wire: Transport<EntityType>

Accessors

Methods

  • Connects a client to an Interop broker. This is called under-the-hood for Views in a Platform.

    Returns

    Tutorial

    Interop.connectSync

    Static

    Parameters

    • name: string

      The name of the Interop Broker to connect to. For Platforms, this will default to the uuid of the Platform.

    • Optional interopConfig: 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 OpenFin.InteropClient

Generated using TypeDoc