AboutSupportDeveloper GuideVersion 41.129.83.2

Interface ApiSettings

Configurations for API injection.

interface ApiSettings {
    fin?: InjectionType;
    iframe?: {
        crossOriginInjection?: boolean;
        enableDeprecatedSharedName?: boolean;
        sameOriginInjection?: boolean;
    };
}

Properties

fin? iframe?

Properties

Optionalfin

fin?: InjectionType

Configure injection of the fin API in this context.

  • 'none': The fin API will be not available in this context.
  • 'global': The entire fin API will be available in this context.

Optionaliframe

iframe?: {
    crossOriginInjection?: boolean;
    enableDeprecatedSharedName?: boolean;
    sameOriginInjection?: boolean;
}

Configure conditional injection of OpenFin API into iframes

Type declaration

  • OptionalcrossOriginInjection?: boolean

    Inject OpenFin API into cross-origin iframes

    Default Value

    false
  • OptionalenableDeprecatedSharedName?: boolean

    Deprecated

    Shared names should not be used; support is provided purely for back-compat reasons.

    When true, iframes will have the same name as their parent WebContents.

  • OptionalsameOriginInjection?: boolean

    Inject OpenFin API into same-origin iframes

    Default Value

    true

Settings

On This Page

Properties