OpenFin Workspace API
    Preparing search index...

    Interface DockProviderRegistration

    Return type from the Dock registration call.

    interface DockProviderRegistration {
        clientAPIVersion: string;
        updateDockProviderConfig: (request: DockProviderConfig) => Promise<void>;
        workspaceVersion: string;
    }

    Hierarchy (View Summary)

    Index
    clientAPIVersion updateDockProviderConfig workspaceVersion
    clientAPIVersion: string

    Client API version

    This is the version of the Workspace client API that is being used to register the component.

    updateDockProviderConfig: (request: DockProviderConfig) => Promise<void>

    Updates the Dock configuration.

    Type Declaration

      • (request: DockProviderConfig): Promise<void>

      • Parameters

        Returns Promise<void>

        Promise that resolves when the update completes.

    import { Dock, type DockProviderConfig } from '@openfin/workspace';

    const newConfig: DockProviderConfig = {
        buttons: [
            {
                tooltip: "Sample Button 1",
                iconUrl: "https://www.openfin.co/favicon-32x32.png",
                action: {
                    id: "sampleButton1",
                },
            },
        ],
    };

    await dockProviderRegistration.updateDockProviderConfig(newConfig);
    workspaceVersion: string

    Workspace version

    This is the version of Workspace that the Workspace component is running on. This could be used to determine if the component is running on a version of Workspace that supports a particular feature.

    Settings

    On This Page
    Properties