Theia API Documentation v1.65.0
Eclipse Theia Website
GitHub
Preparing search index...
@theia/ai-core
common/variable-service
AIVariableService
Interface AIVariableService
interface
AIVariableService
{
onDidChangeVariables
:
Event
<
void
>
;
getArgumentCompletionProvider
(
name
:
string
,
)
:
Promise
<
undefined
|
AIVariableArgCompletionProvider
>
;
getArgumentPicker
(
name
:
string
,
context
:
AIVariableContext
,
)
:
Promise
<
undefined
|
AIVariableArgPicker
>
;
getContextVariables
()
:
Readonly
<
AIContextVariable
>
[]
;
getResolver
(
name
:
string
,
arg
:
undefined
|
string
,
context
:
AIVariableContext
,
)
:
Promise
<
undefined
|
AIVariableResolver
>
;
getVariable
(
name
:
string
)
:
undefined
|
Readonly
<
AIVariable
>
;
getVariables
()
:
Readonly
<
AIVariable
>
[]
;
hasVariable
(
name
:
string
)
:
boolean
;
registerArgumentCompletionProvider
(
variable
:
AIVariable
,
argPicker
:
AIVariableArgCompletionProvider
,
)
:
Disposable
;
registerArgumentPicker
(
variable
:
AIVariable
,
argPicker
:
AIVariableArgPicker
,
)
:
Disposable
;
registerResolver
(
variable
:
AIVariable
,
resolver
:
AIVariableResolver
,
)
:
Disposable
;
registerVariable
(
variable
:
AIVariable
)
:
Disposable
;
resolveVariable
(
variable
:
AIVariableArg
,
context
:
AIVariableContext
,
cache
?:
Map
<
string
,
ResolveAIVariableCacheEntry
>
,
)
:
Promise
<
undefined
|
ResolvedAIVariable
>
;
unregisterArgumentCompletionProvider
(
variable
:
AIVariable
,
argPicker
:
AIVariableArgCompletionProvider
,
)
:
void
;
unregisterArgumentPicker
(
variable
:
AIVariable
,
argPicker
:
AIVariableArgPicker
,
)
:
void
;
unregisterResolver
(
variable
:
AIVariable
,
resolver
:
AIVariableResolver
,
)
:
void
;
unregisterVariable
(
name
:
string
)
:
void
;
}
Hierarchy (
View Summary
)
AIVariableService
FrontendVariableService
Implemented by
DefaultAIVariableService
Index
Properties
on
Did
Change
Variables
Methods
get
Argument
Completion
Provider
get
Argument
Picker
get
Context
Variables
get
Resolver
get
Variable
get
Variables
has
Variable
register
Argument
Completion
Provider
register
Argument
Picker
register
Resolver
register
Variable
resolve
Variable
unregister
Argument
Completion
Provider
unregister
Argument
Picker
unregister
Resolver
unregister
Variable
Properties
Readonly
on
Did
Change
Variables
onDidChangeVariables
:
Event
<
void
>
Methods
get
Argument
Completion
Provider
getArgumentCompletionProvider
(
name
:
string
,
)
:
Promise
<
undefined
|
AIVariableArgCompletionProvider
>
Parameters
name
:
string
Returns
Promise
<
undefined
|
AIVariableArgCompletionProvider
>
get
Argument
Picker
getArgumentPicker
(
name
:
string
,
context
:
AIVariableContext
,
)
:
Promise
<
undefined
|
AIVariableArgPicker
>
Parameters
name
:
string
context
:
AIVariableContext
Returns
Promise
<
undefined
|
AIVariableArgPicker
>
get
Context
Variables
getContextVariables
()
:
Readonly
<
AIContextVariable
>
[]
Returns
Readonly
<
AIContextVariable
>
[]
get
Resolver
getResolver
(
name
:
string
,
arg
:
undefined
|
string
,
context
:
AIVariableContext
,
)
:
Promise
<
undefined
|
AIVariableResolver
>
Parameters
name
:
string
arg
:
undefined
|
string
context
:
AIVariableContext
Returns
Promise
<
undefined
|
AIVariableResolver
>
get
Variable
getVariable
(
name
:
string
)
:
undefined
|
Readonly
<
AIVariable
>
Parameters
name
:
string
Returns
undefined
|
Readonly
<
AIVariable
>
get
Variables
getVariables
()
:
Readonly
<
AIVariable
>
[]
Returns
Readonly
<
AIVariable
>
[]
has
Variable
hasVariable
(
name
:
string
)
:
boolean
Parameters
name
:
string
Returns
boolean
register
Argument
Completion
Provider
registerArgumentCompletionProvider
(
variable
:
AIVariable
,
argPicker
:
AIVariableArgCompletionProvider
,
)
:
Disposable
Parameters
variable
:
AIVariable
argPicker
:
AIVariableArgCompletionProvider
Returns
Disposable
register
Argument
Picker
registerArgumentPicker
(
variable
:
AIVariable
,
argPicker
:
AIVariableArgPicker
,
)
:
Disposable
Parameters
variable
:
AIVariable
argPicker
:
AIVariableArgPicker
Returns
Disposable
register
Resolver
registerResolver
(
variable
:
AIVariable
,
resolver
:
AIVariableResolver
)
:
Disposable
Parameters
variable
:
AIVariable
resolver
:
AIVariableResolver
Returns
Disposable
register
Variable
registerVariable
(
variable
:
AIVariable
)
:
Disposable
Parameters
variable
:
AIVariable
Returns
Disposable
resolve
Variable
resolveVariable
(
variable
:
AIVariableArg
,
context
:
AIVariableContext
,
cache
?:
Map
<
string
,
ResolveAIVariableCacheEntry
>
,
)
:
Promise
<
undefined
|
ResolvedAIVariable
>
Parameters
variable
:
AIVariableArg
context
:
AIVariableContext
Optional
cache
:
Map
<
string
,
ResolveAIVariableCacheEntry
>
Returns
Promise
<
undefined
|
ResolvedAIVariable
>
unregister
Argument
Completion
Provider
unregisterArgumentCompletionProvider
(
variable
:
AIVariable
,
argPicker
:
AIVariableArgCompletionProvider
,
)
:
void
Parameters
variable
:
AIVariable
argPicker
:
AIVariableArgCompletionProvider
Returns
void
unregister
Argument
Picker
unregisterArgumentPicker
(
variable
:
AIVariable
,
argPicker
:
AIVariableArgPicker
,
)
:
void
Parameters
variable
:
AIVariable
argPicker
:
AIVariableArgPicker
Returns
void
unregister
Resolver
unregisterResolver
(
variable
:
AIVariable
,
resolver
:
AIVariableResolver
)
:
void
Parameters
variable
:
AIVariable
resolver
:
AIVariableResolver
Returns
void
unregister
Variable
unregisterVariable
(
name
:
string
)
:
void
Parameters
name
:
string
Returns
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
on
Did
Change
Variables
Methods
get
Argument
Completion
Provider
get
Argument
Picker
get
Context
Variables
get
Resolver
get
Variable
get
Variables
has
Variable
register
Argument
Completion
Provider
register
Argument
Picker
register
Resolver
register
Variable
resolve
Variable
unregister
Argument
Completion
Provider
unregister
Argument
Picker
unregister
Resolver
unregister
Variable
Eclipse Theia Website
GitHub
Theia API Documentation v1.65.0
Loading...