Search
Preparing search index...
The search index is not available
Theia TypeDoc
Options
All
Public
Public/Protected
All
Inherited
Menu
Theia TypeDoc
core
PreferenceServiceImpl
Class PreferenceServiceImpl
Hierarchy
PreferenceServiceImpl
Implements
PreferenceService
Index
Constructors
constructor
Properties
_is
Ready
_ready
configurations
on
Preference
Changed
on
Preference
Changed
Emitter
on
Preferences
Changed
on
Preferences
Changed
Emitter
preference
Override
Service
preference
Providers
provider
Provider
schema
to
Dispose
Accessors
is
Ready
ready
Methods
dispose
do
Get
do
Has
do
Inspect
In
Scope
do
Resolve
get
get
Affected
Preference
Names
get
Boolean
get
Config
Uri
get
Number
get
Provider
get
Scoped
Value
From
Inspection
get
Scopes
To
Change
get
String
has
init
initialize
Providers
inspect
inspect
In
Scope
overridden
Preference
Name
override
Preference
Name
reconcile
Preferences
resolve
set
update
Value
Constructors
constructor
new
Preference
Service
Impl
(
)
:
PreferenceServiceImpl
Returns
PreferenceServiceImpl
Properties
Protected
_is
Ready
_is
Ready
:
boolean
= false
Protected
Readonly
_ready
_ready
:
Deferred
<
void
>
= ...
Protected
Readonly
configurations
configurations
:
PreferenceConfigurations
Readonly
on
Preference
Changed
on
Preference
Changed
:
Event
<
PreferenceChange
>
= ...
Protected
Readonly
on
Preference
Changed
Emitter
on
Preference
Changed
Emitter
:
Emitter
<
PreferenceChange
>
= ...
Readonly
on
Preferences
Changed
on
Preferences
Changed
:
Event
<
PreferenceChanges
>
= ...
Protected
Readonly
on
Preferences
Changed
Emitter
on
Preferences
Changed
Emitter
:
Emitter
<
PreferenceChanges
>
= ...
Protected
Readonly
preference
Override
Service
preference
Override
Service
:
PreferenceLanguageOverrideService
Protected
Readonly
preference
Providers
preference
Providers
:
Map
<
PreferenceScope
,
PreferenceProvider
>
= ...
Protected
Readonly
provider
Provider
provider
Provider
:
PreferenceProviderProvider
Protected
Readonly
schema
schema
:
PreferenceSchemaProvider
Protected
Readonly
to
Dispose
to
Dispose
:
DisposableCollection
= ...
Accessors
is
Ready
get
isReady
(
)
:
boolean
Returns
boolean
ready
get
ready
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
Methods
dispose
dispose
(
)
:
void
Returns
void
Protected
do
Get
do
Get
<
T
>
(
preferenceName
:
string
, defaultValue
?:
T
, resourceUri
?:
string
)
:
undefined
|
T
Type Parameters
T
Parameters
preferenceName:
string
Optional
defaultValue:
T
Optional
resourceUri:
string
Returns
undefined
|
T
Protected
do
Has
do
Has
(
preferenceName
:
string
, resourceUri
?:
string
)
:
boolean
Parameters
preferenceName:
string
Optional
resourceUri:
string
Returns
boolean
Protected
do
Inspect
In
Scope
do
Inspect
In
Scope
<
T
>
(
preferenceName
:
string
, scope
:
PreferenceScope
, resourceUri
?:
string
)
:
undefined
|
T
Type Parameters
T
Parameters
preferenceName:
string
scope:
PreferenceScope
Optional
resourceUri:
string
Returns
undefined
|
T
Protected
do
Resolve
do
Resolve
<
T
>
(
preferenceName
:
string
, defaultValue
?:
T
, resourceUri
?:
string
)
:
PreferenceResolveResult
<
T
>
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
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
Optional
defaultValue:
T
Optional
resourceUri:
string
Returns
undefined
|
T
Protected
get
Affected
Preference
Names
get
Affected
Preference
Names
(
change
:
PreferenceProviderDataChange
, accept
:
(
(
affectedPreferenceName
:
string
)
=>
void
)
)
:
void
Parameters
change:
PreferenceProviderDataChange
accept:
(
(
affectedPreferenceName
:
string
)
=>
void
)
(
affectedPreferenceName
:
string
)
:
void
Parameters
affectedPreferenceName:
string
Returns
void
Returns
void
get
Boolean
get
Boolean
(
preferenceName
:
string
)
:
undefined
|
boolean
get
Boolean
(
preferenceName
:
string
, defaultValue
:
boolean
)
:
boolean
get
Boolean
(
preferenceName
:
string
, defaultValue
:
boolean
, resourceUri
:
string
)
:
boolean
Parameters
preferenceName:
string
Returns
undefined
|
boolean
Parameters
preferenceName:
string
defaultValue:
boolean
Returns
boolean
Parameters
preferenceName:
string
defaultValue:
boolean
resourceUri:
string
Returns
boolean
get
Config
Uri
get
Config
Uri
(
scope
:
PreferenceScope
, resourceUri
?:
string
, sectionName
?:
string
)
:
undefined
|
URI
Parameters
scope:
PreferenceScope
Optional
resourceUri:
string
sectionName:
string
= ...
Returns
undefined
|
URI
get
Number
get
Number
(
preferenceName
:
string
)
:
undefined
|
number
get
Number
(
preferenceName
:
string
, defaultValue
:
number
)
:
number
get
Number
(
preferenceName
:
string
, defaultValue
:
number
, resourceUri
:
string
)
:
number
Parameters
preferenceName:
string
Returns
undefined
|
number
Parameters
preferenceName:
string
defaultValue:
number
Returns
number
Parameters
preferenceName:
string
defaultValue:
number
resourceUri:
string
Returns
number
Protected
get
Provider
get
Provider
(
scope
:
PreferenceScope
)
:
undefined
|
PreferenceProvider
Parameters
scope:
PreferenceScope
Returns
undefined
|
PreferenceProvider
Protected
get
Scoped
Value
From
Inspection
get
Scoped
Value
From
Inspection
<
T
>
(
inspection
:
PreferenceInspection
<
T
>
, scope
:
PreferenceScope
)
:
undefined
|
T
Type Parameters
T
Parameters
inspection:
PreferenceInspection
<
T
>
scope:
PreferenceScope
Returns
undefined
|
T
Protected
get
Scopes
To
Change
get
Scopes
To
Change
(
inspection
:
PreferenceInspection
<
any
>
, intendedValue
:
any
)
:
PreferenceScope
[]
Parameters
inspection:
PreferenceInspection
<
any
>
intendedValue:
any
Returns
PreferenceScope
[]
get
String
get
String
(
preferenceName
:
string
)
:
undefined
|
string
get
String
(
preferenceName
:
string
, defaultValue
:
string
)
:
string
get
String
(
preferenceName
:
string
, defaultValue
:
string
, resourceUri
:
string
)
:
string
Parameters
preferenceName:
string
Returns
undefined
|
string
Parameters
preferenceName:
string
defaultValue:
string
Returns
string
Parameters
preferenceName:
string
defaultValue:
string
resourceUri:
string
Returns
string
has
has
(
preferenceName
:
string
, resourceUri
?:
string
)
:
boolean
Parameters
preferenceName:
string
Optional
resourceUri:
string
Returns
boolean
Protected
init
init
(
)
:
void
Returns
void
Protected
initialize
Providers
initialize
Providers
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
inspect
inspect
<
T
>
(
preferenceName
:
string
, resourceUri
?:
string
, forceLanguageOverride
?:
boolean
)
:
undefined
|
PreferenceInspection
<
T
>
Type Parameters
T
extends
JSONValue
Parameters
preferenceName:
string
Optional
resourceUri:
string
Optional
forceLanguageOverride:
boolean
Returns
undefined
|
PreferenceInspection
<
T
>
inspect
In
Scope
inspect
In
Scope
<
T
>
(
preferenceName
:
string
, scope
:
PreferenceScope
, resourceUri
?:
string
, forceLanguageOverride
?:
boolean
)
:
undefined
|
T
Type Parameters
T
extends
JSONValue
Parameters
preferenceName:
string
scope:
PreferenceScope
Optional
resourceUri:
string
Optional
forceLanguageOverride:
boolean
Returns
undefined
|
T
overridden
Preference
Name
overridden
Preference
Name
(
preferenceName
:
string
)
:
undefined
|
OverridePreferenceName
Parameters
preferenceName:
string
Returns
undefined
|
OverridePreferenceName
override
Preference
Name
override
Preference
Name
(
options
:
OverridePreferenceName
)
:
string
Parameters
options:
OverridePreferenceName
Returns
string
Protected
reconcile
Preferences
reconcile
Preferences
(
changes
:
PreferenceProviderDataChanges
)
:
void
Parameters
changes:
PreferenceProviderDataChanges
Returns
void
resolve
resolve
<
T
>
(
preferenceName
:
string
, defaultValue
?:
T
, resourceUri
?:
string
)
:
PreferenceResolveResult
<
T
>
Type Parameters
T
Parameters
preferenceName:
string
Optional
defaultValue:
T
Optional
resourceUri:
string
Returns
PreferenceResolveResult
<
T
>
set
set
(
preferenceName
:
string
, value
:
any
, scope
:
undefined
|
PreferenceScope
, resourceUri
?:
string
)
:
Promise
<
void
>
Parameters
preferenceName:
string
value:
any
scope:
undefined
|
PreferenceScope
Optional
resourceUri:
string
Returns
Promise
<
void
>
update
Value
update
Value
(
preferenceName
:
string
, value
:
any
, resourceUri
?:
string
)
:
Promise
<
void
>
Parameters
preferenceName:
string
value:
any
Optional
resourceUri:
string
Returns
Promise
<
void
>
Modules
bulk-
edit
callhierarchy
console
core
Application
Error
Application
Shell
Application
Shell
Layout
Migration
Error
Application
Shell
Mouse
Tracker
Array
Utils
Badge
Widget
Binary
Buffer
Readable
Binary
Buffer
Readable
Buffered
Stream
Binary
Buffer
Readable
Stream
Binary
Buffer
Writeable
Stream
Bindable
CSSIcon
Cancellation
Token
Color
Command
Command
Menu
Node
Common
Commands
Common
Menus
Composite
Tree
Element
Composite
Tree
Element
Node
Composite
Tree
Node
Compound
Menu
Node
Console
Logger
Context
Key
Decorated
Tree
Node
Decoration
Style
Default
Json
Schema
Contribution
Description
Widget
Dialog
Dialog
Error
Diff
Uris
Disposable
Disposable
Group
Dynamic
Toolbar
Widget
Electron
Commands
Electron
Main
Process
Argv
Electron
Menus
Electron
Messaging
Service
Electron
Text
Input
Context
Menu
Endpoint
Event
Event
Listener
Object
Expandable
Tree
Node
Extractable
Widget
File
Uri
Focusable
Tree
Selection
Frontend
Application
Preference
Config
Fuzzy
Search
Hover
Position
IPCEntry
Point
Iterators
Key
Key
Code
Key
Modifier
Key
Sequence
Keybinding
Keybinding
Contexts
Keybinding
Registry
Keybinding
Scope
Keyboard
Commands
Keys
Or
Key
Codes
Label
Icon
Localization
Log
Level
Markdown
String
Menu
Action
Menu
Toolbar
Item
Messaging
Contribution
Messaging
Service
Mock
Tree
Model
Navigatable
Navigatable
Widget
Navigatable
Widget
Options
OS
On
Will
Stop
Action
Override
Preference
Name
Path
Preference
Data
Property
Preference
Provider
Data
Change
Preference
Schema
Preference
Schema
Properties
Preference
Scope
Prioritizeable
Progress
Message
Quick
Input
Button
Quick
Pick
Item
Quick
Pick
Separator
Raw
Keybinding
Readable
Resource
Resource
Error
Saveable
Saveable
Widget
Scrollable
Tab
Bar
Search
Box
Search
Box
Debounce
Options
Search
Box
Props
Selectable
Tree
Node
Selection
Command
Handler
Severity
Shell
Layout
Restorer
Side
Panel
Special
Cases
Stateful
Widget
Styles
Tab
Bar
Delegator
Tab
Bar
Toolbar
Tab
Bar
Toolbar
Item
Text
Document
Content
Change
Delta
Theia
Dock
Panel
Theia
RendererAPI
Tree
Element
Node
Tree
Iterator
Tree
Model
Impl
Tree
Node
Tree
Selection
Tree
Selection
Service
Impl
Tree
Source
Node
Tree
Widget
Tree
Widget
Selection
URIIcon
Reference
Unsafe
Widget
Utilities
Uri
Aware
Command
Handler
Uri
Selection
View
Container
View
Container
Layout
View
Container
Part
Wait
Until
Event
Widget
Decoration
Window
Commands
Zoom
Level
nls
debug
editor
editor-
preview
electron
external-
terminal
file-
search
filesystem
getting-
started
git
keymaps
markers
memory-
inspector
messages
metrics
mini-
browser
monaco
navigator
outline-
view
output
plugin
plugin-
dev
plugin-
ext
plugin-
ext-
vscode
plugin-
metrics
preferences
preview
process
property-
view
scm
scm-
extra
search-
in-
workspace
secondary-
window
task
terminal
timeline
toolbar
typehierarchy
userstorage
variable-
resolver
vsx-
registry
workspace
Preference
Service
Impl
constructor
_is
Ready
_ready
configurations
on
Preference
Changed
on
Preference
Changed
Emitter
on
Preferences
Changed
on
Preferences
Changed
Emitter
preference
Override
Service
preference
Providers
provider
Provider
schema
to
Dispose
is
Ready
ready
dispose
do
Get
do
Has
do
Inspect
In
Scope
do
Resolve
get
get
Affected
Preference
Names
get
Boolean
get
Config
Uri
get
Number
get
Provider
get
Scoped
Value
From
Inspection
get
Scopes
To
Change
get
String
has
init
initialize
Providers
inspect
inspect
In
Scope
overridden
Preference
Name
override
Preference
Name
reconcile
Preferences
resolve
set
update
Value