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

    Interface PreferenceSchemaService

    interface PreferenceSchemaService {
        onDidChangeDefaultValue: Event<DefaultValueChangedEvent>;
        onDidChangeSchema: Event<void>;
        overrideIdentifiers: ReadonlySet<string>;
        ready: Promise<void>;
        validScopes: readonly PreferenceScope[];
        addSchema(schema: PreferenceSchema): Disposable;
        getDefaultValue(
            key: string,
            overrideIdentifier: undefined | string,
        ): undefined | JSONValue;
        getDefaultValues(): JSONObject;
        getJSONSchema(scope: PreferenceScope): IJSONSchema;
        getSchemaProperties(): ReadonlyMap<string, PreferenceDataProperty>;
        getSchemaProperty(key: string): undefined | PreferenceDataProperty;
        inspectDefaultValue(
            key: string,
            overrideIdentifier: undefined | string,
        ): undefined | JSONValue;
        isValidInScope(preferenceName: string, scope: PreferenceScope): boolean;
        registerOverride(
            key: string,
            overrideIdentifier: undefined | string,
            value: JSONValue,
        ): Disposable;
        registerOverrideIdentifier(overrideIdentifier: string): Disposable;
        updateSchemaProperty(key: string, property: PreferenceDataProperty): void;
    }

    Implemented by

    Index

    Properties

    onDidChangeDefaultValue onDidChangeSchema overrideIdentifiers ready validScopes

    Methods

    addSchema getDefaultValue getDefaultValues getJSONSchema getSchemaProperties getSchemaProperty inspectDefaultValue isValidInScope registerOverride registerOverrideIdentifier updateSchemaProperty

    Properties

    onDidChangeDefaultValue: Event<DefaultValueChangedEvent>

    Public events

    onDidChangeSchema: Event<void>
    overrideIdentifiers: ReadonlySet<string>
    ready: Promise<void>

    Resolves after static contributions have been processed

    validScopes: readonly PreferenceScope[]

    The scopes which this preference schema service handles. Any properties that are not applicable within the valid scopes will be ignored

    Methods

    • Get the default value for a preference. This is the value a client will see for the given key/override

      Parameters

      • key: string

        The preference key

      • overrideIdentifier: undefined | string

        The override identifier, undefined for global default

      Returns undefined | JSONValue

      The default value or undefined if not found

    • Get the collection of all defined default values as JSONObject of the form like in a preferences.json

      {
        "my.preference": "a string default",
        "[typescript]": {
           "another.preference": 39
        }

      Returns JSONObject

    • Gets the default value for a preference. This method not fall back to the global value if no override is given

      Parameters

      • key: string

        The preference key

      • overrideIdentifier: undefined | string

        The override identifier, undefined for global default

      Returns undefined | JSONValue

      The default value or undefined if not found

    • Register an override for a preference default value. If multiple overrides are registered for the same value, the last override will be in effect. Removing the last override will make the second-to-last override active, etc.

      Parameters

      • key: string

        The preference key

      • overrideIdentifier: undefined | string

        The override identifier, undefined for global default

      • value: JSONValue

        The default value

      Returns Disposable

      A disposable to unregister the override

    Settings

    Member Visibility

    On This Page

    Properties
    Methods