Theia API Documentation v1.65.0
    Preparing search index...

    Interface PluginDeployerHandler

    interface PluginDeployerHandler {
        deployBackendPlugins(
            backendPlugins: PluginDeployerEntry[],
        ): Promise<undefined | number>;
        deployFrontendPlugins(
            frontendPlugins: PluginDeployerEntry[],
        ): Promise<undefined | number>;
        disablePlugin(pluginId: `${string}.${string}@${string}`): Promise<boolean>;
        enablePlugin(pluginId: `${string}.${string}@${string}`): Promise<boolean>;
        getDeployedPlugin(
            pluginId: `${string}.${string}@${string}`,
        ): undefined | DeployedPlugin;
        getDeployedPluginIds(): Promise<readonly `${string}.${string}@${string}`[]>;
        getDeployedPlugins(): Promise<DeployedPlugin[]>;
        getDeployedPluginsById(pluginId: string): DeployedPlugin[];
        getPluginDependencies(
            pluginToBeInstalled: PluginDeployerEntry,
        ): Promise<undefined | PluginDependencies>;
        undeployPlugin(pluginId: `${string}.${string}@${string}`): Promise<boolean>;
        uninstallPlugin(
            pluginId: `${string}.${string}@${string}`,
        ): Promise<boolean>;
    }

    Implemented by

    Index

    Methods

    deployBackendPlugins deployFrontendPlugins disablePlugin enablePlugin getDeployedPlugin getDeployedPluginIds getDeployedPlugins getDeployedPluginsById getPluginDependencies undeployPlugin uninstallPlugin

    Methods

    • Marks the given plugins as "disabled". While the plugin remains installed, it will no longer be used. Has no effect if the plugin is not installed

      Parameters

      • pluginId: `${string}.${string}@${string}`

        the plugin to disable

      Returns Promise<boolean>

      whether the plugin was installed, enabled and could be disabled

    • Marks the given plugins as "enabled". Has no effect if the plugin is not installed.

      Parameters

      • pluginId: `${string}.${string}@${string}`

        the plugin to enabled

      Returns Promise<boolean>

      whether the plugin was installed, disabled and could be enabled

    • Removes the plugin from the locations to which it had been deployed. This operation is not safe - references to deleted assets may remain.

      Parameters

      • pluginId: `${string}.${string}@${string}`

      Returns Promise<boolean>

    • Removes the plugin from the location it originally resided on disk. Unless --uncompressed-plugins-in-place is passed to the CLI, this operation is safe.

      Parameters

      • pluginId: `${string}.${string}@${string}`

      Returns Promise<boolean>

    Settings

    Member Visibility

    On This Page

    Methods