Class UserConfigsPreferenceProvider

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

Hierarchy

PreferenceProvider
- UserConfigsPreferenceProvider

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new UserConfigsPreferenceProvider(): UserConfigsPreferenceProvider

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

Properties

Protected Readonly configurations

configurations: PreferenceConfigurations

Protected Readonly providerFactory

providerFactory: UserPreferenceProviderFactory

Protected Readonly providers

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

Methods

Protected createProvider

createProvider(uri: URI, sectionName: string): UserPreferenceProvider

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

Protected createProviders

createProviders(): void

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

Protected doInit

doInit(): Promise<void>

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

getConfigUri

getConfigUri(resourceUri?: string, sectionName?: string): undefined | URI

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

getPreferences

getPreferences(resourceUri?: string): {}

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

Protected init

init(): void

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

resolve

resolve<T>(preferenceName: string, resourceUri?: string): PreferenceResolveResult<T>

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

setPreference

setPreference(preferenceName: string, value: any, resourceUri?: string): Promise<boolean>

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