PreferenceServiceImpl | Theia TypeDoc

Hierarchy

PreferenceServiceImpl

Implements

PreferenceService

Index

Constructors

constructor

Properties

Accessors

ready

Constructors

constructor

new PreferenceServiceImpl(): PreferenceServiceImpl

Returns PreferenceServiceImpl

Properties

Protected Readonly _ready

_ready: Deferred<void>

Protected Readonly configurations

configurations: PreferenceConfigurations

Readonly onPreferenceChanged

onPreferenceChanged: Event<PreferenceChange>

Protected Readonly onPreferenceChangedEmitter

onPreferenceChangedEmitter: Emitter<PreferenceChange>

Readonly onPreferencesChanged

onPreferencesChanged: Event<PreferenceChanges>

Protected Readonly onPreferencesChangedEmitter

onPreferencesChangedEmitter: Emitter<PreferenceChanges>

Protected Readonly toDispose

toDispose: DisposableCollection

Accessors

ready

get ready(): Promise<void>

- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:262
Returns Promise<void>

Methods

dispose

dispose(): void

Implementation of PreferenceService.dispose
- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:260
Returns void

Protected doGet

doGet<T>(preferenceName: string, defaultValue?: T, resourceUri?: string): undefined | T

- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:291
Type parameters
- T
Parameters
- preferenceName: string
- Optional defaultValue: T
- Optional resourceUri: string
Returns undefined | T

Protected doHas

doHas(preferenceName: string, resourceUri?: string): boolean

- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:289
Parameters
- preferenceName: string
- Optional resourceUri: string
Returns boolean

Protected doInspectInScope

doInspectInScope<T>(preferenceName: string, scope: PreferenceScope, resourceUri?: string): undefined | T

- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:290
Type parameters
- T
Parameters
- preferenceName: string
- scope: PreferenceScope
- Optional resourceUri: string
Returns undefined | T

Protected doResolve

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

- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:292
Type parameters
- T
Parameters
- preferenceName: string
- Optional defaultValue: T
- Optional resourceUri: string
Returns PreferenceResolveResult<T>

get

get<T>(preferenceName: string): undefined | T
get<T>(preferenceName: string, defaultValue: T): T
get<T>(preferenceName: string, defaultValue: T, resourceUri: string): T
get<T>(preferenceName: string, defaultValue?: T, resourceUri?: string): undefined | T

Implementation of PreferenceService.get
- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:267
Type parameters
- T
Parameters
- preferenceName: string
Returns undefined | T
Implementation of PreferenceService.get
- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:268
Type parameters
- T
Parameters
- preferenceName: string
- defaultValue: T
Returns T
Implementation of PreferenceService.get
- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:269
Type parameters
- T
Parameters
- preferenceName: string
- defaultValue: T
- resourceUri: string
Returns T
Implementation of PreferenceService.get
- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:270
Type parameters
- T
Parameters
- preferenceName: string
- Optional defaultValue: T
- Optional resourceUri: string
Returns undefined | T

Protected getAffectedPreferenceNames

getAffectedPreferenceNames(change: PreferenceProviderDataChange, accept: (affectedPreferenceName: string) => void): void

- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:264
Parameters
- change: PreferenceProviderDataChange
- accept: (affectedPreferenceName: string) => void
  - - (affectedPreferenceName: string): void
    - Parameters
      - affectedPreferenceName: string
      Returns void
Returns void

getBoolean

getBoolean(preferenceName: string): undefined | boolean
getBoolean(preferenceName: string, defaultValue: boolean): boolean
getBoolean(preferenceName: string, defaultValue: boolean, resourceUri: string): boolean

- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:273
Parameters
- preferenceName: string
Returns undefined | boolean
- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:274
Parameters
- preferenceName: string
- defaultValue: boolean
Returns boolean
- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:275
Parameters
- preferenceName: string
- defaultValue: boolean
- resourceUri: string
Returns boolean

getConfigUri

getConfigUri(scope: PreferenceScope, resourceUri?: string, sectionName?: string): undefined | default

Implementation of PreferenceService.getConfigUri
- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:293
Parameters
- scope: PreferenceScope
- Optional resourceUri: string
- Optional sectionName: string
Returns undefined | default

getNumber

getNumber(preferenceName: string): undefined | number
getNumber(preferenceName: string, defaultValue: number): number
getNumber(preferenceName: string, defaultValue: number, resourceUri: string): number

- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:279
Parameters
- preferenceName: string
Returns undefined | number
- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:280
Parameters
- preferenceName: string
- defaultValue: number
Returns number
- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:281
Parameters
- preferenceName: string
- defaultValue: number
- resourceUri: string
Returns number

Protected getProvider

getProvider(scope: PreferenceScope): undefined | PreferenceProvider

- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:265
Parameters
- scope: PreferenceScope
Returns undefined | PreferenceProvider

Protected getScopedValueFromInspection

getScopedValueFromInspection<T>(inspection: PreferenceInspection<T>, scope: PreferenceScope): undefined | T

- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:284
Type parameters
- T
Parameters
- inspection: PreferenceInspection<T>
- scope: PreferenceScope
Returns undefined | T

Protected getScopesToChange

getScopesToChange(inspection: PreferenceInspection<any>, intendedValue: any): PreferenceScope[]

- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:286
Parameters
- inspection: PreferenceInspection<any>
- intendedValue: any
Returns PreferenceScope[]

getString

getString(preferenceName: string): undefined | string
getString(preferenceName: string, defaultValue: string): string
getString(preferenceName: string, defaultValue: string, resourceUri: string): string

- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:276
Parameters
- preferenceName: string
Returns undefined | string
- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:277
Parameters
- preferenceName: string
- defaultValue: string
Returns string
- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:278
Parameters
- preferenceName: string
- defaultValue: string
- resourceUri: string
Returns string

has

has(preferenceName: string, resourceUri?: string): boolean

- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:266
Parameters
- preferenceName: string
- Optional resourceUri: string
Returns boolean

Protected init

init(): void

- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:259
Returns void

Protected initializeProviders

initializeProviders(): Promise<void>

- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:258
Returns Promise<void>

inspect

inspect<T>(preferenceName: string, resourceUri?: string): undefined | PreferenceInspection<T>

Implementation of PreferenceService.inspect
- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:282
Type parameters
- T
Parameters
- preferenceName: string
- Optional resourceUri: string
Returns undefined | PreferenceInspection<T>

Protected inspectInScope

inspectInScope<T>(preferenceName: string, scope: PreferenceScope, resourceUri?: string): undefined | T

- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:283
Type parameters
- T
Parameters
- preferenceName: string
- scope: PreferenceScope
- Optional resourceUri: string
Returns undefined | T

overriddenPreferenceName

overriddenPreferenceName(preferenceName: string): undefined | OverridePreferenceName

Implementation of PreferenceService.overriddenPreferenceName
- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:288
Parameters
- preferenceName: string
Returns undefined | OverridePreferenceName

overridePreferenceName

overridePreferenceName(options: OverridePreferenceName): string

Implementation of PreferenceService.overridePreferenceName
- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:287
Parameters
- options: OverridePreferenceName
Returns string

Protected reconcilePreferences

reconcilePreferences(changes: PreferenceProviderDataChanges): void

- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:263
Parameters
- changes: PreferenceProviderDataChanges
Returns void

resolve

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

Implementation of PreferenceService.resolve
- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:271
Type parameters
- T
Parameters
- preferenceName: string
- Optional defaultValue: T
- Optional resourceUri: string
Returns PreferenceResolveResult<T>

set

set(preferenceName: string, value: any, scope: undefined | Default | User | Workspace | Folder, resourceUri?: string): Promise<void>

Implementation of PreferenceService.set
- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:272
Parameters
- preferenceName: string
- value: any
- scope: undefined | Default | User | Workspace | Folder
- Optional resourceUri: string
Returns Promise<void>

updateValue

updateValue(preferenceName: string, value: any, resourceUri?: string): Promise<void>

Implementation of PreferenceService.updateValue
- Defined in packages/core/lib/browser/preferences/preference-service.d.ts:285
Parameters
- preferenceName: string
- value: any
- Optional resourceUri: string
Returns Promise<void>

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns PreferenceServiceImpl

Properties

Protected Readonly _ready

Protected Readonly configurations

Readonly onPreferenceChanged

Protected Readonly onPreferenceChangedEmitter

Readonly onPreferencesChanged

Protected Readonly onPreferencesChangedEmitter

Protected Readonly preferenceOverrideService

Protected Readonly preferenceProviders

Protected Readonly providerProvider

Protected Readonly schema

Protected Readonly toDispose

Accessors

ready

Returns Promise<void>

Methods

dispose

Returns void

Protected doGet

Type parameters

T

Parameters

preferenceName: string

Optional defaultValue: T

Optional resourceUri: string

Returns undefined | T

Protected doHas

Parameters

preferenceName: string

Optional resourceUri: string

Returns boolean

Protected doInspectInScope

Type parameters

T

Parameters

preferenceName: string

scope: PreferenceScope

Optional resourceUri: string

Returns undefined | T

Protected doResolve

Type parameters

T

Parameters

preferenceName: string

Optional defaultValue: T

Optional resourceUri: string

Returns PreferenceResolveResult<T>

get

Type parameters

T

Parameters

preferenceName: string

Returns undefined | T

Type parameters

T

Parameters

preferenceName: string

defaultValue: T

Returns T

Type parameters

T

Parameters

preferenceName: string

defaultValue: T

resourceUri: string

Returns T

Type parameters

T

Parameters

preferenceName: string