Protected
Readonly
_readyProtected
deferredProtected
fireRest
...arguments: []Readonly
onProtected
Readonly
onProtected
Readonly
preferenceReadonly
prefsProtected
scopeProtected
Readonly
toResolved when the preference provider is ready to provide preferences It should be resolved by subclasses.
Protected
emitRetrieve the stored value for the given preference and resource URI.
the preference identifier.
Optional
resourceUri: stringthe uri of the resource for which the preference is stored. This is used to retrieve
a potentially different value for the same preference for different resources, for example files.encoding
.
the value stored for the given preference and resourceUri if it exists, otherwise undefined
.
Retrieve the configuration URI for the given resource URI.
Optional
resourceUri: stringthe uri of the resource or undefined
.
Optional
sectionName: stringthe section to return the URI for, e.g. tasks
or launch
. Defaults to settings.
the corresponding resource URI or undefined
if there is no valid URI.
Optional
getRetrieves the first valid configuration URI contained by the given resource.
Optional
resourceUri: stringthe uri of the container resource or undefined
.
Optional
sectionName: stringthe first valid configuration URI contained by the given resource undefined
if there is no valid configuration URI at all.
Protected
getProtected
mergeResolve the value for the given preference and resource URI.
the preference identifier.
Optional
resourceUri: stringthe URI of the resource for which this provider should resolve the preference. This is used to retrieve
a potentially different value for the same preference for different resources, for example files.encoding
.
an object containing the value stored for the given preference and resourceUri if it exists,
otherwise undefined
.
Stores a new value for the given preference key in the provider.
the preference key (typically the name).
the new preference value.
Optional
resourceUri: stringthe URI of the resource for which the preference is stored.
a promise that only resolves if all changes were delivered.
If changes were made then implementation must either
await on this.emitPreferencesChangedEvent(...)
or
this.pendingChanges
if changes are fired indirectly.
Static
deepStatic
merge
The PreferenceProvider is used to store and retrieve preference values. A PreferenceProvider does not operate in a global scope but is configured for one or more PreferenceScopes. The (default implementation for the) PreferenceService aggregates all PreferenceProviders and serves as a common facade for manipulating preference values.