Class WorkspacePreferenceProvider

Hierarchy

PreferenceProvider
- WorkspacePreferenceProvider

Index

Constructors

Properties

_delegate folderPreferenceProvider toDisposeOnEnsureDelegateUpToDate workspaceFileProviderFactory workspaceService

Accessors

Methods

createDelegate ensureDelegateUpToDate ensureResourceUri get getConfigUri getContainingConfigUri getPreferences init resolve setPreference

Constructors

constructor

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

Properties

`Protected` _delegate

_delegate: undefined | PreferenceProvider

`Protected` `Readonly` folderPreferenceProvider

folderPreferenceProvider: PreferenceProvider

`Protected` `Readonly` toDisposeOnEnsureDelegateUpToDate

toDisposeOnEnsureDelegateUpToDate: DisposableCollection = ...

`Protected` `Readonly` workspaceFileProviderFactory

workspaceFileProviderFactory: WorkspaceFilePreferenceProviderFactory

`Protected` `Readonly` workspaceService

workspaceService: WorkspaceService

Accessors

`Protected` delegate

get delegate(): undefined | PreferenceProvider
Returns undefined | PreferenceProvider
- Defined in packages/preferences/src/browser/workspace-preference-provider.ts:62

Methods

`Protected` createDelegate

createDelegate(): undefined | PreferenceProvider
Returns undefined | PreferenceProvider
- Defined in packages/preferences/src/browser/workspace-preference-provider.ts:88

`Protected` ensureDelegateUpToDate

ensureDelegateUpToDate(): void
Returns void
- Defined in packages/preferences/src/browser/workspace-preference-provider.ts:66

`Protected` ensureResourceUri

ensureResourceUri(): undefined | string
Returns undefined | string
- Defined in packages/preferences/src/browser/workspace-preference-provider.ts:127

get

get<T>(preferenceName, resourceUri?): undefined | T
Type Parameters
- T
Parameters
- preferenceName: string
- resourceUri: undefined | string = ...
Returns undefined | T
Overrides PreferenceProvider.get
- Defined in packages/preferences/src/browser/workspace-preference-provider.ts:104

getConfigUri

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

getContainingConfigUri

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

getPreferences

getPreferences(resourceUri?): {
[p: string]: any;
}
Parameters
- resourceUri: undefined | string = ...
Returns {
[p: string]: any;
}
- [p: string]: any
Overrides PreferenceProvider.getPreferences
- Defined in packages/preferences/src/browser/workspace-preference-provider.ts:114

`Protected` init

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

resolve

resolve<T>(preferenceName, resourceUri?): {
configUri?: URI;
value?: T;
}
Type Parameters
- T
Parameters
- preferenceName: string
- resourceUri: undefined | string = ...
Returns {
configUri?: URI;
value?: T;
}
- Optional configUri?: URI
- Optional value?: T
Overrides PreferenceProvider.resolve
- Defined in packages/preferences/src/browser/workspace-preference-provider.ts:109

setPreference

setPreference(preferenceName, value, resourceUri?): Promise<boolean>
Parameters
- preferenceName: string
- value: any
- resourceUri: undefined | string = ...
Returns Promise<boolean>
Overrides PreferenceProvider.setPreference
- Defined in packages/preferences/src/browser/workspace-preference-provider.ts:119