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

    Interface PluginInstallBackendService

    Performs all Agent Plugin filesystem and network work: the plugins root lives outside the browser FileService sandbox.

    Installing is two-phase so that a content-hash mismatch is an explicit user decision rather than something discovered after the plugin is already in place: stage downloads and verifies without touching the final location, and the frontend then commits or discards. Registering the resolved components is the frontend's job, after commit returns.

    interface PluginInstallBackendService {
        commit(
            stagingId: string,
            replaceExisting: boolean,
        ): Promise<InstalledPluginInfo>;
        discard(stagingId: string): Promise<void>;
        getPluginsRoot(): Promise<string>;
        link(
            entry: ResolvedPluginEntry,
            directoryName: string,
        ): Promise<InstalledPluginInfo>;
        listInstalledPlugins(): Promise<InstalledPluginInfo[]>;
        stage(entry: ResolvedPluginEntry): Promise<StagedPluginInstall>;
        uninstall(pluginId: string): Promise<void>;
        unlink(pluginId: string): Promise<void>;
    }

    Implemented by

    Index

    Methods

    commit discard getPluginsRoot link listInstalledPlugins stage uninstall unlink

    Methods

    Settings

    Member Visibility

    On This Page

    Methods