Class UserConfigsPreferenceProvider

Binds together preference section prefs providers for user-level preferences.

Hierarchy (View Summary)

PreferenceProviderImpl
- UserConfigsPreferenceProvider

Constructors

constructor

new UserConfigsPreferenceProvider(): UserConfigsPreferenceProvider
Returns UserConfigsPreferenceProvider
Inherited from PreferenceProviderImpl.constructor
- Defined in packages/core/lib/common/preferences/preference-provider-impl.d.ts:29

Properties

`Protected` `Readonly`_ready

_ready: Deferred<void>

`Protected` `Readonly`configurations

configurations: PreferenceConfigurations

`Protected`deferredChanges

deferredChanges: undefined | PreferenceProviderDataChanges

`Protected`fireDidPreferencesChanged

fireDidPreferencesChanged: () => Promise<boolean>

`Protected` `Readonly`providers

providers: Map<string, UserPreferenceProvider> = ...

`Protected` `Readonly`toDispose

toDispose: DisposableCollection

Accessors

ready

get ready(): Promise<void>
Resolved when the preference provider is ready to provide preferences It should be resolved by subclasses.

Returns Promise<void>
Inherited from PreferenceProviderImpl.ready
- Defined in packages/core/lib/common/preferences/preference-provider-impl.d.ts:38

Methods

canHandleScope

canHandleScope(scope: PreferenceScope): boolean
Whether t
Parameters
- scope: PreferenceScope
  the scope to handle
Returns boolean
Inherited from PreferenceProviderImpl.canHandleScope
- Defined in packages/core/lib/common/preferences/preference-provider-impl.d.ts:50

`Protected`createProvider

createProvider(uri: URI, sectionName: string): UserPreferenceProvider
Parameters
- uri: URI
- sectionName: string
Returns UserPreferenceProvider
- Defined in packages/preferences/src/common/user-configs-preference-provider.ts:125

`Protected`createProviders

createProviders(userStorageLocation: URI): void
Parameters
- userStorageLocation: URI
Returns void
- Defined in packages/preferences/src/common/user-configs-preference-provider.ts:59

dispose

dispose(): void
Dispose this object.

Returns void
Inherited from PreferenceProviderImpl.dispose
- Defined in packages/core/lib/common/preferences/preference-provider-impl.d.ts:20

`Protected`doInit

doInit(): Promise<void>
Returns Promise<void>
- Defined in packages/preferences/src/common/user-configs-preference-provider.ts:48

`Protected`emitPreferencesChangedEvent

emitPreferencesChangedEvent(
changes: PreferenceProviderDataChanges | PreferenceProviderDataChange[],
): Promise<boolean>
Informs the listeners that one or more preferences of this provider are changed. The listeners are able to find what was changed from the emitted event.
Parameters
- changes: PreferenceProviderDataChanges | PreferenceProviderDataChange[]
Returns Promise<boolean>
Inherited from PreferenceProviderImpl.emitPreferencesChangedEvent
- Defined in packages/core/lib/common/preferences/preference-provider-impl.d.ts:17

get

get<T>(preferenceName: string, resourceUri?: string): undefined | T
Retrieve the stored value for the given preference and resource URI.
Type Parameters
- T
Parameters
- preferenceName: string
  the preference identifier.
- OptionalresourceUri: string
  the 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.
Returns undefined | T
the value stored for the given preference and resourceUri if it exists, otherwise undefined.
Inherited from PreferenceProviderImpl.get
- Defined in packages/core/lib/common/preferences/preference-provider-impl.d.ts:30

getConfigUri

getConfigUri(resourceUri?: string, sectionName?: string): undefined | URI
Retrieve the configuration URI for the given resource URI.
Parameters
- OptionalresourceUri: string
  the uri of the resource or undefined.
- sectionName: string = ...
  the section to return the URI for, e.g. tasks or launch. Defaults to settings.
Returns undefined | URI
the corresponding resource URI or undefined if there is no valid URI.
Overrides PreferenceProviderImpl.getConfigUri
- Defined in packages/preferences/src/common/user-configs-preference-provider.ts:70

`Optional`getContainingConfigUri

getContainingConfigUri?(
resourceUri?: string,
sectionName?: string,
): undefined | URI
Retrieves the first valid configuration URI contained by the given resource.
Parameters
- OptionalresourceUri: string
  the uri of the container resource or undefined.
- OptionalsectionName: string
Returns undefined | URI
the first valid configuration URI contained by the given resource undefined if there is no valid configuration URI at all.
Inherited from PreferenceProviderImpl.getContainingConfigUri
- Defined in packages/core/lib/common/preferences/preference-provider-impl.d.ts:46

getDomain

getDomain(): undefined | string[]
Retrieve the domain for this provider.

Returns undefined | string[]
the domain or undefined if this provider is suitable for all domains.
Inherited from PreferenceProviderImpl.getDomain
- Defined in packages/core/lib/common/preferences/preference-provider-impl.d.ts:44

`Protected`getParsedContent

getParsedContent(jsonData: unknown): { [key: string]: unknown }
Parameters
- jsonData: unknown
Returns { [key: string]: unknown }
Inherited from PreferenceProviderImpl.getParsedContent
- Defined in packages/core/lib/common/preferences/preference-provider-impl.d.ts:47

getPreferences

getPreferences(resourceUri?: string): { [p: string]: any }
Return a JSONObject with all preferences stored in this preference provider
Parameters
- OptionalresourceUri: string
Returns { [p: string]: any }
Overrides PreferenceProviderImpl.getPreferences
- Defined in packages/preferences/src/common/user-configs-preference-provider.ts:92

`Protected`init

init(): void
Returns void
- Defined in packages/preferences/src/common/user-configs-preference-provider.ts:44

`Protected`mergePreferenceProviderDataChange

mergePreferenceProviderDataChange(change: PreferenceProviderDataChange): void
Parameters
- change: PreferenceProviderDataChange
Returns void
Inherited from PreferenceProviderImpl.mergePreferenceProviderDataChange
- Defined in packages/core/lib/common/preferences/preference-provider-impl.d.ts:18

resolve

resolve<T>(
preferenceName: string,
resourceUri?: string,
): PreferenceResolveResult<T>
Resolve the value for the given preference and resource URI.
Type Parameters
- T
Parameters
- preferenceName: string
  the preference identifier.
- OptionalresourceUri: string
  the 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.
Returns PreferenceResolveResult<T>
an object containing the value stored for the given preference and resourceUri if it exists, otherwise undefined.
Overrides PreferenceProviderImpl.resolve
- Defined in packages/preferences/src/common/user-configs-preference-provider.ts:80

setPreference

setPreference(
    preferenceName: string,
    value: any,
    resourceUri?: string,
): Promise<boolean>
Stores a new value for the given preference key in the provider.
Parameters
- preferenceName: string
  the preference key (typically the name).
- value: any
  the new preference value.
- OptionalresourceUri: string
  the URI of the resource for which the preference is stored.
Returns Promise<boolean>
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.
Overrides PreferenceProviderImpl.setPreference
- Defined in packages/preferences/src/common/user-configs-preference-provider.ts:101

Class UserConfigsPreferenceProvider

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns UserConfigsPreferenceProvider

Properties

Protected Readonly_ready

Protected Readonlyconfigurations

ProtecteddeferredChanges

ProtectedfireDidPreferencesChanged

ReadonlyonDidPreferencesChanged

Protected ReadonlyonDidPreferencesChangedEmitter

Protected ReadonlyproviderFactory

Protected Readonlyproviders

Protected ReadonlytoDispose

Accessors

ready

Returns Promise<void>

Methods

canHandleScope

Parameters

Returns boolean

ProtectedcreateProvider

Parameters

Returns UserPreferenceProvider

ProtectedcreateProviders

Parameters

Returns void

dispose

Returns void

ProtecteddoInit

Returns Promise<void>

ProtectedemitPreferencesChangedEvent

Parameters

Returns Promise<boolean>

get

Type Parameters

Parameters

Returns undefined | T

getConfigUri

Parameters

Returns undefined | URI

OptionalgetContainingConfigUri

Parameters

Returns undefined | URI

getDomain

Returns undefined | string[]

ProtectedgetParsedContent

Parameters

Returns { [key: string]: unknown }

getPreferences

Parameters

Returns { [p: string]: any }

Protectedinit

Returns void

ProtectedmergePreferenceProviderDataChange

Parameters

Returns void

resolve

Type Parameters

Parameters

Returns PreferenceResolveResult<T>

setPreference

Parameters

Returns Promise<boolean>

Settings

On This Page

`Protected` `Readonly`_ready

`Protected` `Readonly`configurations

`Protected`deferredChanges

`Protected`fireDidPreferencesChanged

`Readonly`onDidPreferencesChanged

`Protected` `Readonly`onDidPreferencesChangedEmitter

`Protected` `Readonly`providerFactory

`Protected` `Readonly`providers

`Protected` `Readonly`toDispose

`Protected`createProvider

`Protected`createProviders

`Protected`doInit

`Protected`emitPreferencesChangedEvent

`Optional`getContainingConfigUri

`Protected`getParsedContent

`Protected`init

`Protected`mergePreferenceProviderDataChange