Class UserConfigsPreferenceProvider

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

Hierarchy

PreferenceProvider
- UserConfigsPreferenceProvider

Index

Constructors

Properties

configurations providerFactory providers

Methods

createProvider createProviders doInit getConfigUri getPreferences init resolve setPreference

Constructors

constructor

new UserConfigsPreferenceProvider(): UserConfigsPreferenceProvider
Returns UserConfigsPreferenceProvider
Inherited from PreferenceProvider.constructor
- Defined in packages/core/lib/browser/preferences/preference-provider.d.ts:50

Properties

`Protected` `Readonly` configurations

configurations: PreferenceConfigurations

`Protected` `Readonly` providerFactory

providerFactory: UserPreferenceProviderFactory

`Protected` `Readonly` providers

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

Methods

`Protected` createProvider

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

`Protected` createProviders

createProviders(): void
Returns void
- Defined in packages/preferences/src/browser/user-configs-preference-provider.ts:55

`Protected` doInit

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

getConfigUri

getConfigUri(resourceUri?, sectionName?): undefined | URI
Parameters
- Optional resourceUri: string
- sectionName: string = ...
Returns undefined | URI
Overrides PreferenceProvider.getConfigUri
- Defined in packages/preferences/src/browser/user-configs-preference-provider.ts:66

getPreferences

getPreferences(resourceUri?): {
[p: string]: any;
}
Parameters
- Optional resourceUri: string
Returns {
[p: string]: any;
}
- [p: string]: any
Overrides PreferenceProvider.getPreferences
- Defined in packages/preferences/src/browser/user-configs-preference-provider.ts:88

`Protected` init

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

resolve

resolve<T>(preferenceName, resourceUri?): PreferenceResolveResult<T>
Type Parameters
- T
Parameters
- preferenceName: string
- Optional resourceUri: string
Returns PreferenceResolveResult<T>
Overrides PreferenceProvider.resolve
- Defined in packages/preferences/src/browser/user-configs-preference-provider.ts:76

setPreference

setPreference(preferenceName, value, resourceUri?): Promise<boolean>
Parameters
- preferenceName: string
- value: any
- Optional resourceUri: string
Returns Promise<boolean>
Overrides PreferenceProvider.setPreference
- Defined in packages/preferences/src/browser/user-configs-preference-provider.ts:97