Theia API Documentation v1.65.0
Eclipse Theia Website
GitHub
Preparing search index...
@theia/plugin-ext
common/plugin-protocol
PluginServer
Interface PluginServer
interface
PluginServer
{
disablePlugin
(
pluginId
:
`
${
string
}
.
${
string
}
@
${
string
}
`
,
)
:
Promise
<
boolean
>
;
enablePlugin
(
pluginId
:
`
${
string
}
.
${
string
}
@
${
string
}
`
)
:
Promise
<
boolean
>
;
getAllStorageValues
(
kind
:
PluginStorageKind
)
:
Promise
<
KeysToKeysToAnyValue
>
;
getDisabledPlugins
()
:
Promise
<
readonly
`
${
string
}
.
${
string
}
@
${
string
}
`
[]
>
;
getInstalledPlugins
()
:
Promise
<
readonly
`
${
string
}
.
${
string
}
@
${
string
}
`
[]
>
;
getStorageValue
(
key
:
string
,
kind
:
PluginStorageKind
,
)
:
Promise
<
KeysToAnyValues
>
;
getUninstalledPlugins
()
:
Promise
<
readonly
`
${
string
}
.
${
string
}
@
${
string
}
`
[]
,
>
;
install
(
pluginEntry
:
string
,
type
?:
PluginType
,
options
?:
PluginDeployOptions
,
)
:
Promise
<
void
>
;
setStorageValue
(
key
:
string
,
value
:
KeysToAnyValues
,
kind
:
PluginStorageKind
,
)
:
Promise
<
boolean
>
;
uninstall
(
pluginId
:
`
${
string
}
.
${
string
}
@
${
string
}
`
)
:
Promise
<
void
>
;
}
Implemented by
PluginServerImpl
Index
Methods
disable
Plugin
enable
Plugin
get
All
Storage
Values
get
Disabled
Plugins
get
Installed
Plugins
get
Storage
Value
get
Uninstalled
Plugins
install
set
Storage
Value
uninstall
Methods
disable
Plugin
disablePlugin
(
pluginId
:
`
${
string
}
.
${
string
}
@
${
string
}
`
)
:
Promise
<
boolean
>
Parameters
pluginId
:
`
${
string
}
.
${
string
}
@
${
string
}
`
Returns
Promise
<
boolean
>
enable
Plugin
enablePlugin
(
pluginId
:
`
${
string
}
.
${
string
}
@
${
string
}
`
)
:
Promise
<
boolean
>
Parameters
pluginId
:
`
${
string
}
.
${
string
}
@
${
string
}
`
Returns
Promise
<
boolean
>
get
All
Storage
Values
getAllStorageValues
(
kind
:
PluginStorageKind
)
:
Promise
<
KeysToKeysToAnyValue
>
Parameters
kind
:
PluginStorageKind
Returns
Promise
<
KeysToKeysToAnyValue
>
get
Disabled
Plugins
getDisabledPlugins
()
:
Promise
<
readonly
`
${
string
}
.
${
string
}
@
${
string
}
`
[]
>
Returns
Promise
<
readonly
`
${
string
}
.
${
string
}
@
${
string
}
`
[]
>
get
Installed
Plugins
getInstalledPlugins
()
:
Promise
<
readonly
`
${
string
}
.
${
string
}
@
${
string
}
`
[]
>
Returns
Promise
<
readonly
`
${
string
}
.
${
string
}
@
${
string
}
`
[]
>
get
Storage
Value
getStorageValue
(
key
:
string
,
kind
:
PluginStorageKind
)
:
Promise
<
KeysToAnyValues
>
Parameters
key
:
string
kind
:
PluginStorageKind
Returns
Promise
<
KeysToAnyValues
>
get
Uninstalled
Plugins
getUninstalledPlugins
()
:
Promise
<
readonly
`
${
string
}
.
${
string
}
@
${
string
}
`
[]
>
Returns
Promise
<
readonly
`
${
string
}
.
${
string
}
@
${
string
}
`
[]
>
install
install
(
pluginEntry
:
string
,
type
?:
PluginType
,
options
?:
PluginDeployOptions
,
)
:
Promise
<
void
>
Deploy a plugin.
Parameters
pluginEntry
:
string
Optional
type
:
PluginType
whether a plugin is installed by a system or a user, defaults to a user
Optional
options
:
PluginDeployOptions
Returns
Promise
<
void
>
set
Storage
Value
setStorageValue
(
key
:
string
,
value
:
KeysToAnyValues
,
kind
:
PluginStorageKind
,
)
:
Promise
<
boolean
>
Parameters
key
:
string
value
:
KeysToAnyValues
kind
:
PluginStorageKind
Returns
Promise
<
boolean
>
uninstall
uninstall
(
pluginId
:
`
${
string
}
.
${
string
}
@
${
string
}
`
)
:
Promise
<
void
>
Parameters
pluginId
:
`
${
string
}
.
${
string
}
@
${
string
}
`
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
disable
Plugin
enable
Plugin
get
All
Storage
Values
get
Disabled
Plugins
get
Installed
Plugins
get
Storage
Value
get
Uninstalled
Plugins
install
set
Storage
Value
uninstall
Eclipse Theia Website
GitHub
Theia API Documentation v1.65.0
Loading...
Deploy a plugin.