Establishes a connection to an OpenFin Web Interop Broker, returning a fin object that supports a subset of APIS.

  • fin.InterApplicationBus.Channel
  • fin.Interop
  • fin.me.identity
  • fin.Platform.Layout.init
  • fin.Platform.Layout.create
  • fin.Platform.Layout.destroy
  • fin.Platform.Layout.getCurrentLayoutManagerSync

If the connection to the broker fails.

If the connection elapses the configured timeout

If the provided InheritModeConnectConfig.validateOptions returns false

If connection inheritance is enabled but the current browsing context is not rendered as a View within an OpenFin WebLayout and no ConnectConfig.options are provided.

If a platform object is provided but the layoutSnapshot is invalid.

  • Parameters

    • connectConfig: ConnectConfig

      Config used to initialise the connection

    Returns Promise<Fin<"external connection">>

    Fin api object