Class AbstractResourcePreferenceProvider Abstract

Hierarchy

PreferenceProvider
- AbstractResourcePreferenceProvider
  - SectionPreferenceProvider
  - WorkspaceFilePreferenceProvider

Constructors

constructor

new AbstractResourcePreferenceProvider(): AbstractResourcePreferenceProvider

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

Properties

Protected _fileExists

_fileExists: boolean = false

Protected Readonly configurations

configurations: PreferenceConfigurations

Protected Readonly fileService

fileService: FileService

Protected Readonly loading

loading: Deferred<void> = ...

Protected Readonly onDidChangeValidityEmitter

onDidChangeValidityEmitter: Emitter<boolean> = ...

Protected preferences

preferences: Record<string, any> = {}

Protected Readonly schemaProvider

schemaProvider: PreferenceSchemaProvider

Protected transaction

transaction: undefined | PreferenceTransaction

Protected Readonly transactionFactory

transactionFactory: PreferenceTransactionFactory

Accessors

fileExists

set fileExists(exists: boolean): void

- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:40
Parameters
- exists: boolean
Returns void

onDidChangeValidity

get onDidChangeValidity(): Event<boolean>

- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:47
Returns Event<boolean>

valid

get valid(): boolean

- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:82
Returns boolean

Methods

contains

contains(resourceUri: undefined | string): boolean

- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:95
Parameters
- resourceUri: undefined | string
Returns boolean

Protected doInit

doInit(): Promise<void>

- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:61
Returns Promise<void>

Protected doSetPreference

doSetPreference(key: string, path: string[], value: unknown): Promise<boolean>

- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:119
Parameters
- key: string
- path: string[]
- value: unknown
Returns Promise<boolean>

getConfigUri

getConfigUri(): URI
getConfigUri(resourceUri: undefined | string): undefined | URI

Overrides PreferenceProvider.getConfigUri
- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:86
Returns URI
Overrides PreferenceProvider.getConfigUri
- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:87
Parameters
- resourceUri: undefined | string
Returns undefined | URI

Protected getPath

getPath(preferenceName: string): undefined | string[]

- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:145
Parameters
- preferenceName: string
Returns undefined | string[]

getPreferences

getPreferences(resourceUri?: string): {}

Overrides PreferenceProvider.getPreferences
- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:107
Parameters
- Optional resourceUri: string
Returns {}
- [key: string]: any

Abstract getScope

getScope(): PreferenceScope

- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:80
Returns PreferenceScope

Protected Abstract getUri

getUri(): URI

- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:79
Returns URI

Protected handlePreferenceChanges

handlePreferenceChanges(newPrefs: {}): void

- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:186
Parameters
- newPrefs: {}
  - [key: string]: any
Returns void

Protected init

init(): void

- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:57
Returns void

Protected parse

parse(content: string): any

- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:177
Parameters
- content: string
Returns any

Protected readPreferencesFromContent

readPreferencesFromContent(content: string): void

- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:166
Parameters
- content: string
Returns void

Protected readPreferencesFromFile

readPreferencesFromFile(): Promise<void>

- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:153
Returns Promise<void>

Protected reset

reset(): void

- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:216
Returns void

setPreference

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

Overrides PreferenceProvider.setPreference
- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:111
Parameters
- key: string
- value: any
- Optional resourceUri: string
Returns Promise<boolean>

Protected toFileManager

toFileManager(): PreferenceContext

- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:141
Use this method as intermediary for interactions with actual files. Allows individual providers to modify where they store their files without disrupting the preference system's conventions about scope and file location.

Returns PreferenceContext