Type Alias InheritModeConnectConfig

InheritModeConnectConfig: BaseConfig & {
    connectionInheritance: "enabled";
    options?: BaseConnectionOptions;
    validateOptions?: ((inheritedOptions: Omit<BaseConnectionOptions, "timeout">) => boolean | Promise<boolean>);
}

Type declaration

  • connectionInheritance: "enabled"

    If 'enabled', attempts to inherit connection options if it is running as a View within an OpenFin WebLayout. This means that the brokerUrl and Identity of the connection will be determined by the WebBroker of the page where the WebLayout is instantiated via fin.Platform.Layout.init() call.

    If 'disabled', the options property is required.

    Default Value

    'disabled'
  • Optionaloptions?: BaseConnectionOptions

    Options used to connect to an OpenFin Web Broker. Please note, these will be overriden if connectionInheritance is 'enabled' and supported for the current browsing context. In the case that inherited options are unavailable, these options will be used.

  • OptionalvalidateOptions?: ((inheritedOptions: Omit<BaseConnectionOptions, "timeout">) => boolean | Promise<boolean>)

    Validates the inherited connection options from the parent browsing context, if available.

      • (inheritedOptions): boolean | Promise<boolean>

      • Parameters

        Returns boolean | Promise<boolean>

        True if the connection options are accepted, or false otherwise.

Settings

Member Visibility