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

    Interface ImplementationMetadata

    Metadata relating to the FDC3 Desktop Agent implementation and its provider.

    interface ImplementationMetadata {
        appMetadata: OpenFin.FDC3.v2_0.AppMetadata;
        fdc3Version: string;
        optionalFeatures: {
            OriginatingAppMetadata: boolean;
            UserChannelMembershipAPIs: boolean;
        };
        provider: string;
        providerVersion?: string;
    }
    Index
    appMetadata fdc3Version optionalFeatures provider providerVersion?
    appMetadata: OpenFin.FDC3.v2_0.AppMetadata

    The calling application instance's own metadata, according to the Desktop Agent (MUST include at least the appId and instanceId).

    fdc3Version: string

    The version number of the FDC3 specification that the implementation provides. The string must be a numeric semver version, e.g. 1.2 or 1.2.1.

    optionalFeatures: {
        OriginatingAppMetadata: boolean;
        UserChannelMembershipAPIs: boolean;
    }

    Metadata indicating whether the Desktop Agent implements optional features of the Desktop Agent API.

    Type Declaration

    • ReadonlyOriginatingAppMetadata: boolean

      Used to indicate whether the exposure of 'originating app metadata' for context and intent messages is supported by the Desktop Agent.

    • ReadonlyUserChannelMembershipAPIs: boolean

      Used to indicate whether the optional fdc3.joinUserChannel, fdc3.getCurrentChannel and fdc3.leaveCurrentChannel are implemented by the Desktop Agent.

    provider: string

    The name of the provider of the Desktop Agent implementation (e.g. Finsemble, Glue42, OpenFin etc.).

    providerVersion?: string

    The version of the provider of the Desktop Agent implementation (e.g. 5.3.0).

    Settings

    On This Page
    Properties