AboutSupportDeveloper GuideVersion 22.3.18

Interface DockProviderRegistration

Return type from the Dock registration call.

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

Hierarchy (view full)

Properties

clientAPIVersion updateDockProviderConfig workspaceVersion

Properties

clientAPIVersion

clientAPIVersion: string

Client API version

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

updateDockProviderConfig

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

Updates the Dock configuration.

Type declaration

    • (request): Promise<void>

    • Parameters

      Returns Promise<void>

      Promise that resolves when the update completes.

Example: Update the Dock configuration. This example requires that you have already registered a Dock provider.

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

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