Class PreferenceProxyChange

Representation of a preference change. A preference value can be set to undefined for a specific scope. This means that the value from a more general scope will be used.

Hierarchy (View Summary)

PreferenceChangeImpl
- PreferenceProxyChange

Index

Constructors

Properties

change overrideIdentifier?

Accessors

domain newValue oldValue preferenceName scope

Methods

Constructors

constructor

new PreferenceProxyChange(
change: PreferenceProviderDataChange,
overrideIdentifier?: string,
): PreferenceProxyChange
Parameters
- change: PreferenceProviderDataChange
- OptionaloverrideIdentifier: string
Returns PreferenceProxyChange
Overrides PreferenceChangeImpl.constructor
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:33

Properties

`Protected` `Readonly`change

change: PreferenceProviderDataChange

`Protected` `Optional` `Readonly`overrideIdentifier

overrideIdentifier?: string

Accessors

domain

get domain(): undefined | string[]
URIs of the scopes in which this change applies.

Returns undefined | string[]
Inherited from PreferenceChangeImpl.domain
- Defined in packages/core/src/common/preferences/preference-service.ts:60

newValue

get newValue(): undefined | JSONValue
The new value of the changed preference.

Returns undefined | JSONValue
Inherited from PreferenceChangeImpl.newValue
- Defined in packages/core/src/common/preferences/preference-service.ts:51

oldValue

get oldValue(): undefined | JSONValue
The old value of the changed preference.

Returns undefined | JSONValue
Inherited from PreferenceChangeImpl.oldValue
- Defined in packages/core/src/common/preferences/preference-service.ts:54

preferenceName

get preferenceName(): string
The name of the changed preference.

Returns string
Inherited from PreferenceChangeImpl.preferenceName
- Defined in packages/core/src/common/preferences/preference-service.ts:48

scope

get scope(): PreferenceScope
The PreferenceScope of the changed preference.

Returns PreferenceScope
Inherited from PreferenceChangeImpl.scope
- Defined in packages/core/src/common/preferences/preference-service.ts:57

Methods

affects

affects(resourceUri?: string, overrideIdentifier?: string): boolean
TODO add tests
Parameters
- OptionalresourceUri: string
- OptionaloverrideIdentifier: string
Returns boolean
Overrides PreferenceChangeImpl.affects
- Defined in packages/core/src/common/preferences/injectable-preference-proxy.ts:37