Class Dock3Provider

constructor

• new Dock3Provider(config, channel): Dock3Provider

• Parameters

  • config: Dock3Config
  • channel: Dock3ChannelProvider

  Returns Dock3Provider

Staticinstance

config

• get config(): Dock3Config

• Read-only access to the current configuration of the Dock3Provider.

  Returns Dock3Config
• set config(newConfig): void

• Protected setter for the configuration of the Dock3Provider. This does not save the configuration in storage nor notify the dock about the change. Use updateConfig method to update the configuration and save it. This should only be used internally in a saveConfig override if super.saveConfig is not called.

  Parameters

  • newConfig: Dock3Config

  Returns void

ready

• get ready(): Promise<void>

• Returns a promise that resolves when the Dock3Provider is ready. This is useful to ensure that the dock is fully initialized before performing any operations. The promise will resolve when the dock sends the 'ready' action.

  Returns Promise<void>

bookmarkContentMenuEntry

• bookmarkContentMenuEntry(payload): Promise<void>

• Parameters

  • payload: BookmarkDockEntryPayload

  Returns Promise<void>

getWindowSync

• getWindowSync(): _Window

• Returns _Window

launchEntry

• launchEntry(payload): Promise<void>

• Parameters

  • payload: LaunchDockEntryPayload

  Returns Promise<void>

loadConfig

• loadConfig(): Promise<Dock3Config>

• Called on startup to load the current configuration of the Dock3Provider. If you've overridden the saveConfig method, this should load the configuration from your storage. By default it will load the configuration from local storage. This can be overriden to prevent loading from local storage.

  Returns Promise<Dock3Config>

  The current configuration of the Dock3Provider.

  Example: Prevent loading from local storage:

  class MyDock3Provider extends Dock3Provider {
     async loadConfig(): Promise<Dock3Config> {
        // Do not load from local storage, return the default config
        return this.config;
    }
   }
  Copy

  Example: Load from a custom storage:

  class MyDock3Provider extends Dock3Provider {
    async loadConfig(): Promise<Dock3Config> {
       // Load from a custom storage
       const configFromStorage = await myCustomStorage.getDockConfig();
       // Update local config to ensure it is used.
       if (configFromStorage) {
          this.config = configFromStorage;
       }
       return this.config;
    }
  }
  Copy

saveConfig

• saveConfig(__namedParameters): Promise<void>

• Called whenever the configuration is updated, this method saves the configuration to the storage. This should not be called directly, if you need to update the configuration, use updateConfig method instead.

  Parameters

  • __namedParameters: {
        config: Dock3Config;
    }

    • config: Dock3Config

  Returns Promise<void>

shutdown

• shutdown(): Promise<void>

• Shuts down the Dock3Provider and closes the dock window. This method sends a shutdown message to the dock and then closes the window.

  Returns Promise<void>

updateConfig

• updateConfig(config): Promise<void>

• Updates the configuration of the Dock3Provider. This method updates the configuration, notifies the dock about the change and saves the new configuration to storage (via saveConfig).

  Parameters

  • config: Dock3Config

  Returns Promise<void>

StaticgetOverrideConstructor

• getOverrideConstructor(...args): (new () => Dock3Provider)

• Parameters

  • Rest...args: [config: Dock3Config, channel: Dock3ChannelProvider]

  Returns (new () => Dock3Provider)

  • • new (): Dock3Provider

    • Returns Dock3Provider