Class UserInteractionTool

Implements

ToolProvider

Constructors

constructor

new UserInteractionTool(): UserInteractionTool
Returns UserInteractionTool

Properties

`Protected` `Readonly`editorManager

editorManager: EditorManager

`Protected` `Readonly`openerService

openerService: OpenerService

`Protected` `Readonly`pendingInteractions

pendingInteractions: Map<string, PendingInteraction> = ...

`Protected` `Readonly`resourceProvider

resourceProvider: ResourceProvider

`Protected` `Readonly`scmService

scmService: ScmService

`Protected` `Readonly`workspaceScope

workspaceScope: WorkspaceFunctionScope

`Static`ID

ID: string = USER_INTERACTION_FUNCTION_ID

Methods

cancelInteraction

cancelInteraction(toolCallId: string): void
Parameters
- toolCallId: string
Returns void
- Defined in packages/ai-ide/src/browser/user-interaction-tool.ts:226

`Protected`canResolveUri

canResolveUri(uri: URI): Promise<boolean>
Parameters
- uri: URI
Returns Promise<boolean>
- Defined in packages/ai-ide/src/browser/user-interaction-tool.ts:408

completeInteraction

completeInteraction(toolCallId: string): void
Parameters
- toolCallId: string
Returns void
- Defined in packages/ai-ide/src/browser/user-interaction-tool.ts:203

completeInteractionWith

completeInteractionWith(
    toolCallId: string,
    stepIndex: number,
    partial: Partial<UserInteractionStepResult>,
): void
Set the result for a step and immediately complete the interaction. Use this to atomically pass the user's input value into the result, avoiding any reliance on synchronous state updates between setStepResult and completeInteraction.
Parameters
- toolCallId: string
- stepIndex: number
- partial: Partial<UserInteractionStepResult>
Returns void
- Defined in packages/ai-ide/src/browser/user-interaction-tool.ts:221

`Protected`emptyContentUri

emptyContentUri(path: string): URI
Parameters
- path: string
Returns URI
- Defined in packages/ai-ide/src/browser/user-interaction-tool.ts:404

`Protected`errorContentUri

errorContentUri(path: string, gitRef: string): URI
Parameters
- path: string
- gitRef: string
Returns URI
- Defined in packages/ai-ide/src/browser/user-interaction-tool.ts:386

`Protected`fileNotFoundUri

fileNotFoundUri(path: string): URI
Parameters
- path: string
Returns URI
- Defined in packages/ai-ide/src/browser/user-interaction-tool.ts:399

getTool

getTool(): ToolRequest
Returns ToolRequest
Implementation of ToolProvider.getTool
- Defined in packages/ai-ide/src/browser/user-interaction-tool.ts:176

`Protected`handleInteraction

handleInteraction(
argString: string,
ctx: undefined | ToolInvocationContext,
): Promise<string>
Parameters
- argString: string
- ctx: undefined | ToolInvocationContext
Returns Promise<string>
- Defined in packages/ai-ide/src/browser/user-interaction-tool.ts:317

`Protected`normalizeStepResults

normalizeStepResults(pending: PendingInteraction): UserInteractionStepResult[]
Parameters
- pending: PendingInteraction
Returns UserInteractionStepResult[]
- Defined in packages/ai-ide/src/browser/user-interaction-tool.ts:245

openLink

openLink(link: UserInteractionLink): Promise<void>
Parameters
- link: UserInteractionLink
Returns Promise<void>
- Defined in packages/ai-ide/src/browser/user-interaction-tool.ts:249

`Protected`refNotFoundUri

refNotFoundUri(path: string, gitRef: string): URI
Parameters
- path: string
- gitRef: string
Returns URI
- Defined in packages/ai-ide/src/browser/user-interaction-tool.ts:393

`Protected`resolveDiffSideUri

resolveDiffSideUri(ref: ContentRef, workspaceRoot: URI): Promise<URI>
Parameters
- ref: ContentRef
- workspaceRoot: URI
Returns Promise<URI>
- Defined in packages/ai-ide/src/browser/user-interaction-tool.ts:368

`Protected`resolveUri

resolveUri(ref: PathContentRef, workspaceRoot: URI): undefined | URI
Parameters
- ref: PathContentRef
- workspaceRoot: URI
Returns undefined | URI
- Defined in packages/ai-ide/src/browser/user-interaction-tool.ts:299

setStepResult

setStepResult(
    toolCallId: string,
    stepIndex: number,
    partial: Partial<UserInteractionStepResult>,
): void
Parameters
- toolCallId: string
- stepIndex: number
- partial: Partial<UserInteractionStepResult>
Returns void
- Defined in packages/ai-ide/src/browser/user-interaction-tool.ts:187