AboutSupportDeveloper GuideVersion 47.154.100.2
OpenFin JavaScript API
    Preparing search index...

    Interface ApiSettings

    Configurations for API injection.

    interface ApiSettings {
        fin?: InjectionType;
        iframe?: {
            crossOriginInjection?: boolean;
            enableDeprecatedSharedName?: boolean;
            sameOriginInjection?: boolean;
        };
    }
    Index
    fin? iframe?
    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.
    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

      false
    • OptionalenableDeprecatedSharedName?: boolean

      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

      true

    Settings

    On This Page
    Properties