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

    A plug-in context is a collection of utilities private to a plug-in.

    An instance of a PluginContext is provided as the first parameter to the start of a plug-in.

    interface PluginContext {
        environmentVariableCollection: EnvironmentVariableCollection;
        extension: undefined | Plugin<any>;
        extensionMode: ExtensionMode;
        extensionPath: string;
        extensionUri: Uri;
        globalState: Memento & { setKeysForSync(keys: readonly string[]): void };
        globalStoragePath: string;
        globalStorageUri: Uri;
        languageModelAccessInformation: LanguageModelAccessInformation;
        logPath: string;
        logUri: Uri;
        secrets: SecretStorage;
        storagePath: undefined | string;
        storageUri: undefined | Uri;
        subscriptions: { dispose(): any }[];
        workspaceState: Memento;
        asAbsolutePath(relativePath: string): string;
    }
    Index

    Properties

    environmentVariableCollection: EnvironmentVariableCollection

    Gets the extension's environment variable collection for this workspace, enabling changes to be applied to terminal environment variables.

    extension: undefined | Plugin<any>

    The current extension instance.

    extensionMode: ExtensionMode

    The mode the extension is running in. This is specific to the current extension. One extension may be in ExtensionMode.Development while other extensions in the host run in ExtensionMode.Release.

    extensionPath: string

    The absolute file path of the directory containing the extension.

    extensionUri: Uri

    The uri of the directory containing the extension.

    globalState: Memento & { setKeysForSync(keys: readonly string[]): void }

    A memento object that stores state independent of the current opened workspace.

    Type Declaration

    • setKeysForSync: function
      • Set the keys whose values should be synchronized across devices when synchronizing user-data like configuration, extensions, and mementos.

        Note that this function defines the whole set of keys whose values are synchronized:

        • calling it with an empty array stops synchronization for this memento
        • calling it with a non-empty array replaces all keys whose values are synchronized

        For any given set of keys this function needs to be called only once but there is no harm in repeatedly calling it.

        Parameters

        • keys: readonly string[]

          The set of keys whose values are synced.

        Returns void

    globalStoragePath: string

    An absolute file path in which the extension can store global state. The directory might not exist on disk and creation is up to the extension. However, the parent directory is guaranteed to be existent.

    Use globalState to store key value data.

    Use globalStorageUri instead.

    globalStorageUri: Uri

    The uri of a directory in which the extension can store global state. The directory might not exist on disk and creation is up to the extension. However, the parent directory is guaranteed to be existent.

    Use globalState to store key value data.

    workspace.fs for how to read and write files and folders from an uri.

    languageModelAccessInformation: LanguageModelAccessInformation

    An object that keeps information about how this extension can use language models.

    logPath: string

    An absolute file path of a directory in which the extension can create log files. The directory might not exist on disk and creation is up to the extension. However, the parent directory is guaranteed to be existent.

    logUri: Uri

    The uri of a directory in which the extension can create log files. The directory might not exist on disk and creation is up to the extension. However, the parent directory is guaranteed to be existent. see - workspace.fs for how to read and write files and folders from an uri.

    secrets: SecretStorage

    A storage utility for secrets.

    storagePath: undefined | string

    An absolute file path of a workspace specific directory in which the extension can store private state. The directory might not exist on disk and creation is up to the extension. However, the parent directory is guaranteed to be existent.

    Use workspaceState or globalState to store key value data.

    Use storageUri instead.

    storageUri: undefined | Uri

    The uri of a workspace specific directory in which the extension can store private state. The directory might not exist and creation is up to the extension. However, the parent directory is guaranteed to be existent. The value is undefined when no workspace nor folder has been opened.

    Use workspaceState or globalState to store key value data.

    workspace.fs for how to read and write files and folders from an uri.

    subscriptions: { dispose(): any }[]

    An array to which disposables can be added. When this extension is deactivated the disposables will be disposed.

    workspaceState: Memento

    A memento object that stores state in the context of the currently opened workspace.

    Methods

    • Get the absolute path of a resource contained in the extension.

      Parameters

      • relativePath: string

        A relative path to a resource contained in the extension.

      Returns string

      The absolute path of the resource.