Interface DockProviderRegistration

Type declaration

• • (request): Promise<void>

  • Updates the Dock configuration.

    Parameters

    • request: DockProviderConfig

      The new Dock configuration.

    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);
    Copy