WorkspaceFilePreferenceProvider

Hierarchy

AbstractResourcePreferenceProvider
- WorkspaceFilePreferenceProvider

Constructors

constructor

new WorkspaceFilePreferenceProvider(): WorkspaceFilePreferenceProvider

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

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 Readonly options

options: WorkspaceFilePreferenceProviderOptions

Protected preferences

preferences: Record<string, any> = {}

Protected Readonly schemaProvider

schemaProvider: PreferenceSchemaProvider

Protected sectionsInsideSettings

sectionsInsideSettings: Set<string> = ...

Protected transaction

transaction: undefined | PreferenceTransaction

Protected Readonly transactionFactory

transactionFactory: PreferenceTransactionFactory

Protected Readonly workspaceService

workspaceService: WorkspaceService

Accessors

fileExists

set fileExists(exists: boolean): void

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

onDidChangeValidity

get onDidChangeValidity(): Event<boolean>

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

valid

get valid(): boolean

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

Methods

Protected belongsInSection

belongsInSection(firstSegment: string, remainder: string): boolean

- Defined in packages/preferences/src/browser/workspace-file-preference-provider.ts:88
Parameters
- firstSegment: string
- remainder: string
Returns boolean
true if firstSegment is a section name (e.g. tasks, launch)

contains

contains(resourceUri: undefined | string): boolean

Inherited from AbstractResourcePreferenceProvider.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 AbstractResourcePreferenceProvider.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 AbstractResourcePreferenceProvider.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 AbstractResourcePreferenceProvider.getConfigUri
- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:86
Returns URI
Inherited from AbstractResourcePreferenceProvider.getConfigUri
- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:87
Parameters
- resourceUri: undefined | string
Returns undefined | URI

getDomain

getDomain(): string[]

Overrides AbstractResourcePreferenceProvider.getDomain
- Defined in packages/preferences/src/browser/workspace-file-preference-provider.ts:96
Returns string[]

Protected getPath

getPath(preferenceName: string): string[]

Overrides AbstractResourcePreferenceProvider.getPath
- Defined in packages/preferences/src/browser/workspace-file-preference-provider.ts:67
Parameters
- preferenceName: string
Returns string[]

getPreferences

getPreferences(resourceUri?: string): {}

Inherited from AbstractResourcePreferenceProvider.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 AbstractResourcePreferenceProvider.getScope
- Defined in packages/preferences/src/browser/workspace-file-preference-provider.ts:92
Returns PreferenceScope

Protected getUri

getUri(): URI

Overrides AbstractResourcePreferenceProvider.getUri
- Defined in packages/preferences/src/browser/workspace-file-preference-provider.ts:42
Returns URI

Protected handlePreferenceChanges

handlePreferenceChanges(newPrefs: {}): void

Inherited from AbstractResourcePreferenceProvider.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 AbstractResourcePreferenceProvider.init
- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:57
Returns void

Protected parse

parse(content: string): any

Overrides AbstractResourcePreferenceProvider.parse
- Defined in packages/preferences/src/browser/workspace-file-preference-provider.ts:47
Parameters
- content: string
Returns any

Protected readPreferencesFromContent

readPreferencesFromContent(content: string): void

Inherited from AbstractResourcePreferenceProvider.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 AbstractResourcePreferenceProvider.readPreferencesFromFile
- Defined in packages/preferences/src/browser/abstract-resource-preference-provider.ts:153
Returns Promise<void>

Protected reset

reset(): void

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

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns WorkspaceFilePreferenceProvider

Properties

Protected _fileExists

Protected Readonly configurations

Protected Readonly fileService

Protected Readonly loading

Protected Readonly onDidChangeValidityEmitter

Protected Readonly options

Protected preferences

Protected Readonly schemaProvider

Protected sectionsInsideSettings

Protected transaction

Protected Readonly transactionFactory

Protected Readonly workspaceService

Accessors

fileExists

Parameters

exists: boolean

Returns void

onDidChangeValidity

Returns Event<boolean>

valid

Returns boolean

Methods

Protected belongsInSection

Parameters

firstSegment: string

remainder: string

Returns boolean

contains

Parameters

resourceUri: undefined | string

Returns boolean

Protected doInit

Returns Promise<void>

Protected doSetPreference

Parameters

key: string

path: string[]

value: unknown

Returns Promise<boolean>

getConfigUri

Returns URI

Parameters

resourceUri: undefined | string

Returns undefined | URI

getDomain

Returns string[]

Protected getPath

Parameters

preferenceName: string

Returns string[]

getPreferences

Parameters

Optional resourceUri: string

Returns {}

[key: string]: any

getScope

Returns PreferenceScope

Protected getUri

Returns URI

Protected handlePreferenceChanges

Parameters

newPrefs: {}

[key: string]: any

Returns void

Protected init

Returns void

Protected parse

Parameters

content: string

Returns any