DefaultFrontendVariableService | Theia API Documentation v1.66.0

`Protected`doResolve

doResolve(
    variableName: string,
    arg: undefined | string,
    context: AIVariableContext,
    cache: ResolveAIVariableCache,
): Promise<undefined | ResolvedAIVariable>
Asynchronously resolves a variable, handling its dependencies while preventing cyclical resolution. Selects the appropriate resolver and resolution strategy based on whether nested dependency resolution is supported.
Parameters
- variableName: string
- arg: undefined | string
- context: AIVariableContext
- cache: ResolveAIVariableCache
Returns Promise<undefined | ResolvedAIVariable>
Inherited from DefaultAIVariableService.doResolve
- Defined in ai-core/src/common/variable-service.ts:404

`Protected`getKey

getKey(name: string): string
Parameters
- name: string
Returns string
Inherited from DefaultAIVariableService.getKey
- Defined in ai-core/src/common/variable-service.ts:247

getOpener

getOpener(
    name: string,
    arg: undefined | string,
    context?: AIVariableContext,
): Promise<undefined | AIVariableOpener>
Parameters
- name: string
- arg: undefined | string
- context: AIVariableContext = {}
Returns Promise<undefined | AIVariableOpener>
Implementation of FrontendVariableService.getOpener
- Defined in ai-core/src/browser/frontend-variable-service.ts:182

getPasteResult

getPasteResult(
event: ClipboardEvent,
context: AIVariableContext,
): Promise<AIVariablePasteResult>
Parameters
- event: ClipboardEvent
- context: AIVariableContext
Returns Promise<AIVariablePasteResult>
Implementation of FrontendVariableService.getPasteResult
- Defined in ai-core/src/browser/frontend-variable-service.ts:149

getResolver

getResolver(
    name: string,
    arg: undefined | string,
    context: AIVariableContext,
): Promise<undefined | AIVariableResolver>
Parameters
- name: string
- arg: undefined | string
- context: AIVariableContext
Returns Promise<undefined | AIVariableResolver>
Implementation of FrontendVariableService.getResolver
Inherited from DefaultAIVariableService.getResolver
- Defined in ai-core/src/common/variable-service.ts:251

`Protected`getResolvers

getResolvers(name: string): AIVariableResolver[]
Parameters
- name: string
Returns AIVariableResolver[]
Inherited from DefaultAIVariableService.getResolvers
- Defined in ai-core/src/common/variable-service.ts:256

getVariable

getVariable(name: string): undefined | Readonly<AIVariable>
Parameters
- name: string
Returns undefined | Readonly<AIVariable>
Implementation of FrontendVariableService.getVariable
Inherited from DefaultAIVariableService.getVariable
- Defined in ai-core/src/common/variable-service.ts:279

getVariables

getVariables(): Readonly<AIVariable>[]
Returns Readonly<AIVariable>[]
Implementation of FrontendVariableService.getVariables
Inherited from DefaultAIVariableService.getVariables
- Defined in ai-core/src/common/variable-service.ts:283

hasVariable

hasVariable(name: string): boolean
Parameters
- name: string
Returns boolean
Implementation of FrontendVariableService.hasVariable
Inherited from DefaultAIVariableService.hasVariable
- Defined in ai-core/src/common/variable-service.ts:275

`Protected`initContributions

initContributions(): void
Returns void
Inherited from DefaultAIVariableService.initContributions
- Defined in ai-core/src/common/variable-service.ts:243

onStart

onStart(): void
Called when the application is started. The application shell is not attached yet when this method runs. Should return a promise if it runs asynchronously.

Returns void
Implementation of FrontendApplicationContribution.onStart
- Defined in ai-core/src/browser/frontend-variable-service.ts:112

open

open(request: AIVariableArg, context?: AIVariableContext): Promise<void>
Parameters
- request: AIVariableArg
- Optionalcontext: AIVariableContext
Returns Promise<void>
Implementation of FrontendVariableService.open
- Defined in ai-core/src/browser/frontend-variable-service.ts:191

`Protected`openReadonly

openReadonly(
request: AIVariableResolutionRequest,
context?: AIVariableContext,
): Promise<void>
Parameters
- request: AIVariableResolutionRequest
- context: AIVariableContext = {}
Returns Promise<void>
- Defined in ai-core/src/browser/frontend-variable-service.ts:207

`Protected`parseRequest

parseRequest(
request: AIVariableArg,
): { arg: undefined | string; variableName: string }
Parameters
- request: AIVariableArg
Returns { arg: undefined | string; variableName: string }
Inherited from DefaultAIVariableService.parseRequest
- Defined in ai-core/src/common/variable-service.ts:363

`Protected`prioritize

prioritize(
    name: string,
    arg: undefined | string,
    context: AIVariableContext,
): Promise<AIVariableResolver[]>
Parameters
- name: string
- arg: undefined | string
- context: AIVariableContext
Returns Promise<AIVariableResolver[]>
Inherited from DefaultAIVariableService.prioritize
- Defined in ai-core/src/common/variable-service.ts:260

registerArgumentCompletionProvider

registerArgumentCompletionProvider(
variable: AIVariable,
completionProvider: AIVariableArgCompletionProvider,
): Disposable
Parameters
- variable: AIVariable
- completionProvider: AIVariableArgCompletionProvider
Returns Disposable
Implementation of FrontendVariableService.registerArgumentCompletionProvider
Inherited from DefaultAIVariableService.registerArgumentCompletionProvider
- Defined in ai-core/src/common/variable-service.ts:344

registerArgumentPicker

registerArgumentPicker(
variable: AIVariable,
argPicker: AIVariableArgPicker,
): Disposable
Parameters
- variable: AIVariable
- argPicker: AIVariableArgPicker
Returns Disposable
Implementation of FrontendVariableService.registerArgumentPicker
Inherited from DefaultAIVariableService.registerArgumentPicker
- Defined in ai-core/src/common/variable-service.ts:325

registerDropHandler

registerDropHandler(handler: AIVariableDropHandler): Disposable
Parameters
- handler: AIVariableDropHandler
Returns Disposable
Implementation of FrontendVariableService.registerDropHandler
- Defined in ai-core/src/browser/frontend-variable-service.ts:116

registerOpener

registerOpener(variable: AIVariable, opener: AIVariableOpener): Disposable
Parameters
- variable: AIVariable
- opener: AIVariableOpener
Returns Disposable
Implementation of FrontendVariableService.registerOpener
- Defined in ai-core/src/browser/frontend-variable-service.ts:164

registerPasteHandler

registerPasteHandler(handler: AIVariablePasteHandler): Disposable
Parameters
- handler: AIVariablePasteHandler
Returns Disposable
Implementation of FrontendVariableService.registerPasteHandler
- Defined in ai-core/src/browser/frontend-variable-service.ts:140

registerResolver

registerResolver(variable: AIVariable, resolver: AIVariableResolver): Disposable
Parameters
- variable: AIVariable
- resolver: AIVariableResolver
Returns Disposable
Implementation of FrontendVariableService.registerResolver
Inherited from DefaultAIVariableService.registerResolver
- Defined in ai-core/src/common/variable-service.ts:301

registerVariable

registerVariable(variable: AIVariable): Disposable
Parameters
- variable: AIVariable
Returns Disposable
Implementation of FrontendVariableService.registerVariable
Inherited from DefaultAIVariableService.registerVariable
- Defined in ai-core/src/common/variable-service.ts:291

resolveVariable

resolveVariable(
    request: AIVariableArg,
    context: AIVariableContext,
    cache?: ResolveAIVariableCache,
): Promise<undefined | ResolvedAIVariable>
Parameters
- request: AIVariableArg
- context: AIVariableContext
- cache: ResolveAIVariableCache = ...
Returns Promise<undefined | ResolvedAIVariable>
Implementation of FrontendVariableService.resolveVariable
Inherited from DefaultAIVariableService.resolveVariable
- Defined in ai-core/src/common/variable-service.ts:373

unregisterArgumentCompletionProvider

unregisterArgumentCompletionProvider(
variable: AIVariable,
completionProvider: AIVariableArgCompletionProvider,
): void
Parameters
- variable: AIVariable
- completionProvider: AIVariableArgCompletionProvider
Returns void
Implementation of FrontendVariableService.unregisterArgumentCompletionProvider
Inherited from DefaultAIVariableService.unregisterArgumentCompletionProvider
- Defined in ai-core/src/common/variable-service.ts:351

unregisterArgumentPicker

unregisterArgumentPicker(
variable: AIVariable,
argPicker: AIVariableArgPicker,
): void
Parameters
- variable: AIVariable
- argPicker: AIVariableArgPicker
Returns void
Implementation of FrontendVariableService.unregisterArgumentPicker
Inherited from DefaultAIVariableService.unregisterArgumentPicker
- Defined in ai-core/src/common/variable-service.ts:332

unregisterDropHandler

unregisterDropHandler(handler: AIVariableDropHandler): void
Parameters
- handler: AIVariableDropHandler
Returns void
Implementation of FrontendVariableService.unregisterDropHandler
- Defined in ai-core/src/browser/frontend-variable-service.ts:121

unregisterOpener

unregisterOpener(variable: AIVariable, opener: AIVariableOpener): void
Parameters
- variable: AIVariable
- opener: AIVariableOpener
Returns void
Implementation of FrontendVariableService.unregisterOpener
- Defined in ai-core/src/browser/frontend-variable-service.ts:176

unregisterPasteHandler

unregisterPasteHandler(handler: AIVariablePasteHandler): void
Parameters
- handler: AIVariablePasteHandler
Returns void
Implementation of FrontendVariableService.unregisterPasteHandler
- Defined in ai-core/src/browser/frontend-variable-service.ts:145

unregisterResolver

unregisterResolver(variable: AIVariable, resolver: AIVariableResolver): void
Parameters
- variable: AIVariable
- resolver: AIVariableResolver
Returns void
Implementation of FrontendVariableService.unregisterResolver
Inherited from DefaultAIVariableService.unregisterResolver
- Defined in ai-core/src/common/variable-service.ts:310

unregisterVariable

unregisterVariable(name: string): void
Parameters
- name: string
Returns void
Implementation of FrontendVariableService.unregisterVariable
Inherited from DefaultAIVariableService.unregisterVariable
- Defined in ai-core/src/common/variable-service.ts:319

Class DefaultFrontendVariableService

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DefaultFrontendVariableService

Properties

Protected ReadonlyaiResourceResolver

ProtectedargCompletionProviders

ProtectedargPickers

Protected ReadonlycontributionProvider

ProtecteddropHandlers

Protected Readonlylogger

Protected ReadonlymessageService

ReadonlyonDidChangeVariables

Protected ReadonlyonDidChangeVariablesEmitter

Protectedopeners

Protected ReadonlyopenerService

ProtectedpasteHandlers

Protectedresolvers

Protectedvariables

Methods

ProtecteddoResolve

Parameters

Returns Promise<undefined | ResolvedAIVariable>

getArgumentCompletionProvider

Parameters

Returns Promise<undefined | AIVariableArgCompletionProvider>

getArgumentPicker

Parameters

Returns Promise<undefined | AIVariableArgPicker>

getContextVariables

Returns Readonly<AIContextVariable>[]

getDropResult

Parameters

Returns Promise<AIVariableDropResult>

ProtectedgetKey

Parameters

Returns string

getOpener

Parameters

Returns Promise<undefined | AIVariableOpener>

getPasteResult

Parameters

Returns Promise<AIVariablePasteResult>

getResolver

Parameters

Returns Promise<undefined | AIVariableResolver>

ProtectedgetResolvers

Parameters

Returns AIVariableResolver[]

getVariable

Parameters

Returns undefined | Readonly<AIVariable>

getVariables

Returns Readonly<AIVariable>[]

hasVariable

Parameters

Returns boolean

ProtectedinitContributions

Returns void

onStart

Returns void

open

Parameters

Returns Promise<void>

ProtectedopenReadonly

Parameters

Returns Promise<void>

ProtectedparseRequest

Parameters

Returns { arg: undefined | string; variableName: string }

Protectedprioritize

Parameters

Returns Promise<AIVariableResolver[]>

`Protected` `Readonly`aiResourceResolver

`Protected`argCompletionProviders

`Protected`argPickers

`Protected` `Readonly`contributionProvider

`Protected`dropHandlers

`Protected` `Readonly`logger

`Protected` `Readonly`messageService

`Readonly`onDidChangeVariables

`Protected` `Readonly`onDidChangeVariablesEmitter

`Protected`openers

`Protected` `Readonly`openerService

`Protected`pasteHandlers

`Protected`resolvers

`Protected`variables

`Protected`doResolve

`Protected`getKey

`Protected`getResolvers

`Protected`initContributions

`Protected`openReadonly

`Protected`parseRequest

`Protected`prioritize