Class FolderPreferenceProvider

Hierarchy

SectionPreferenceProvider
- FolderPreferenceProvider

Constructors

constructor

new FolderPreferenceProvider(): FolderPreferenceProvider

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

Properties

Protected _fileExists

_fileExists: boolean = false

Private _folderUri

_folderUri: URI

Protected Readonly configurations

configurations: PreferenceConfigurations

Protected Readonly fileService

fileService: FileService

Protected Readonly folder

folder: FileStat

Protected Readonly loading

loading: Deferred<void> = ...

Protected Readonly onDidChangeValidityEmitter

onDidChangeValidityEmitter: Emitter<boolean> = ...

Protected Readonly preferenceConfigurations

preferenceConfigurations: PreferenceConfigurations

Protected preferences

preferences: Record<string, any> = {}

Protected Readonly schemaProvider

schemaProvider: PreferenceSchemaProvider

Protected Readonly section

section: string

Protected transaction

transaction: undefined | PreferenceTransaction

Protected Readonly transactionFactory

transactionFactory: PreferenceTransactionFactory

Protected Readonly uri

uri: URI

Protected Readonly workspaceService

workspaceService: WorkspaceService

Accessors

fileExists

set fileExists(exists: boolean): void

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

folderUri

get folderUri(): URI

- Defined in packages/preferences/src/browser/folder-preference-provider.ts:41
Returns URI

Private isSection

get isSection(): boolean

Inherited from SectionPreferenceProvider.isSection
- Defined in packages/preferences/src/browser/section-preference-provider.ts:44
Returns boolean

onDidChangeValidity

get onDidChangeValidity(): Event<boolean>

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

valid

get valid(): boolean

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

Methods

contains

contains(resourceUri: undefined | string): boolean

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

Protected doInit

doInit(): Promise<void>

Inherited from SectionPreferenceProvider.doInit
- 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>

Inherited from SectionPreferenceProvider.doSetPreference
- 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

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

getDomain

getDomain(): string[]

Overrides SectionPreferenceProvider.getDomain
- Defined in packages/preferences/src/browser/folder-preference-provider.ts:55
Returns string[]

Protected getPath

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

Inherited from SectionPreferenceProvider.getPath
- Defined in packages/preferences/src/browser/section-preference-provider.ts:71
Parameters
- preferenceName: string
Returns undefined | string[]

getPreferences

getPreferences(resourceUri?: string): {}

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

getScope

getScope(): PreferenceScope

Overrides SectionPreferenceProvider.getScope
- Defined in packages/preferences/src/browser/folder-preference-provider.ts:47
Returns PreferenceScope

Protected getUri

getUri(): URI

Inherited from SectionPreferenceProvider.getUri
- Defined in packages/preferences/src/browser/section-preference-provider.ts:51
Returns URI

Protected handlePreferenceChanges

handlePreferenceChanges(newPrefs: {}): void

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

Protected init

init(): void

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

Protected parse

parse(content: string): any

Inherited from SectionPreferenceProvider.parse
- Defined in packages/preferences/src/browser/section-preference-provider.ts:55
Parameters
- content: string
Returns any

Protected readPreferencesFromContent

readPreferencesFromContent(content: string): void

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

Protected readPreferencesFromFile

readPreferencesFromFile(): Promise<void>

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

Protected reset

reset(): void

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

setPreference

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

Inherited from SectionPreferenceProvider.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

Inherited from SectionPreferenceProvider.toFileManager
- 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