Class AIChatContribution

Representation of a tabbar toolbar contribution.

Hierarchy (View Summary)

AbstractViewContribution<ChatViewWidget>
- AIChatContribution

Implements

Index

Constructors

constructor

Accessors

defaultViewOptions isActiveSessionEmpty viewId viewLabel widget

Constructors

constructor

new AIChatContribution(): AIChatContribution
Returns AIChatContribution
Overrides AbstractViewContribution.constructor
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:116

Properties

`Protected` `Readonly`activationService

activationService: AIActivationService

`Protected`activeSessionEmpty

activeSessionEmpty: boolean = true

Tracks whether the currently active session is empty (= the home / overview is shown). Used to hide toolbar items that only make sense within an open chat (Home, lock/unlock auto-scroll, Summarize Current Session, ...).

`Protected`activeSessionModelListener

activeSessionModelListener: undefined | Disposable

Model listener for the active session; disposed and re-bound on active-session changes.

`Protected` `Readonly`chatAgentService

chatAgentService: ChatAgentService

`Protected` `Readonly`chatService

chatService: ChatService

`Protected`chatViewActiveKey

chatViewActiveKey: ContextKey<boolean>

Context key set to true while the chat view widget is the active widget in the shell. Broader than chatInputFocus/chatResponseFocus (which require DOM focus on a specific sub-widget): clicks on non-focusable parts of the chat view still flip this key, so chat view keybindings remain available.

`Protected` `Readonly`contextKeyService

contextKeyService: ContextKeyService

`Protected` `Readonly`editorManager

editorManager: EditorManager

`Protected`hasPersistedSessions

hasPersistedSessions: boolean = false

Store whether there are persisted sessions to make this information available in command enablement checks which are synchronous.

`Protected` `Readonly`logger

logger: ILogger

`Protected` `Readonly`messageService

messageService: MessageService

`Readonly`onActiveSessionEmptyChanged

onActiveSessionEmptyChanged: Event<void> = ...

Fires when isActiveSessionEmpty flips. Consumed by toolbar items that hide on the overview.

`Protected` `Readonly`onActiveSessionEmptyChangedEmitter

onActiveSessionEmptyChangedEmitter: Emitter<void> = ...

`Protected` `Readonly`options

options: ViewContributionOptions

`Protected` `Readonly`preferenceService

preferenceService: PreferenceService

`Protected` `Readonly`quickInputService

quickInputService: QuickInputService

`Protected` `Readonly`quickView

quickView: QuickViewService

`Protected` `Readonly`secondaryWindowHandler

secondaryWindowHandler: SecondaryWindowHandler

`Protected` `Readonly`shell

shell: ApplicationShell

`Protected` `Readonly`taskContextService

taskContextService: TaskContextService

`Optional` `Readonly`toggleCommand

toggleCommand?: Command

`Protected` `Readonly`widgetManager

widgetManager: WidgetManager

`Protected` `Static` `Readonly`REMOVE_CHAT_BUTTON

REMOVE_CHAT_BUTTON: QuickInputButton = ...

`Protected` `Static` `Readonly`RENAME_CHAT_BUTTON

RENAME_CHAT_BUTTON: QuickInputButton = ...

Accessors

defaultViewOptions

get defaultViewOptions(): ApplicationShell.WidgetOptions
Returns ApplicationShell.WidgetOptions
Inherited from AbstractViewContribution.defaultViewOptions
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:34

isActiveSessionEmpty

get isActiveSessionEmpty(): boolean
True when the chat view currently displays the home/overview (the active session has no requests).

Returns boolean
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:100

viewId

get viewId(): string
Returns string
Inherited from AbstractViewContribution.viewId
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:32

viewLabel

get viewLabel(): string
Returns string
Inherited from AbstractViewContribution.viewLabel
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:33

get widget(): Promise<T>
Returns Promise<T>
Inherited from AbstractViewContribution.widget
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:35

Methods

`Protected`askForChatSession

askForChatSession(): Promise<undefined | QuickPickItem>
Returns Promise<undefined | QuickPickItem>
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:448

`Protected`attachToActiveSession

attachToActiveSession(): void
(Re-)attach a model listener to the currently active session so the Home toolbar item can react when the user submits the first message and the welcome view is replaced by the chat tree.

Returns void
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:168

canExtractChatView

canExtractChatView(chatView: ChatViewWidget): boolean
Parameters
- chatView: ChatViewWidget
Returns boolean
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:646

`Protected`checkPersistedSessions

checkPersistedSessions(): Promise<void>
Returns Promise<void>
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:197

closeView

closeView(): Promise<undefined | ChatViewWidget>
Returns Promise<undefined | ChatViewWidget>
Inherited from AbstractViewContribution.closeView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:39

`Protected`deleteSession

deleteSession(sessionId: string, confirm?: boolean): Promise<void>
Parameters
- sessionId: string
- confirm: boolean = false
Returns Promise<void>
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:610

`Protected`extractChatView

extractChatView(chatView: ChatViewWidget): void
Parameters
- chatView: ChatViewWidget
Returns void
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:642

`Protected`getOpenedTaskContextFiles

getOpenedTaskContextFiles(): { activeId?: string; openedIds: string[] }
Returns information about task context files that are currently opened

Returns { activeId?: string; openedIds: string[] }
Object with arrays of opened context IDs and the active context ID
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:728

initialize

initialize(): void
Called on application startup before configure is called.

Returns void
Implementation of FrontendApplicationContribution.initialize
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:130

initializeLayout

initializeLayout(): Promise<void>
Called after the application shell has been attached in case there is no previous workbench layout state. Should return a promise if it runs asynchronously.

Returns Promise<void>
Implementation of FrontendApplicationContribution.initializeLayout
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:189

openView

openView(args?: Partial<OpenViewArguments>): Promise<ChatViewWidget>
Parameters
- Optionalargs: Partial<OpenViewArguments>
Returns Promise<ChatViewWidget>
Inherited from AbstractViewContribution.openView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:37

registerCommands

registerCommands(registry: CommandRegistry): void
Register commands and handlers.
Parameters
- registry: CommandRegistry
Returns void
Overrides AbstractViewContribution.registerCommands
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:206

registerKeybindings

registerKeybindings(keybindings: KeybindingRegistry): void
Registers keybindings.
Parameters
- keybindings: KeybindingRegistry
  the keybinding registry.
Returns void
Overrides AbstractViewContribution.registerKeybindings
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:366

registerMenus

registerMenus(menus: MenuModelRegistry): void
Registers menus.
Parameters
- menus: MenuModelRegistry
  the menu model registry.
Returns void
Inherited from AbstractViewContribution.registerMenus
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:41

registerToolbarItems

registerToolbarItems(registry: TabBarToolbarRegistry): void
Registers toolbar items.
Parameters
- registry: TabBarToolbarRegistry
  the tabbar toolbar registry.
Returns void
Implementation of TabBarToolbarContribution.registerToolbarItems
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:387

`Protected`renameSession

renameSession(sessionId: string): Promise<void>
Parameters
- sessionId: string
Returns Promise<void>
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:601

`Protected`selectAgent

selectAgent(defaultAgentId?: string): Promise<undefined | ChatAgent>
Prompts the user to select a chat agent with an optional default (pre-selected) agent.
Parameters
- OptionaldefaultAgentId: string
  The id of the agent to pre-select, if present
Returns Promise<undefined | ChatAgent>
The selected agent or undefined if cancelled
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:666

`Protected`selectChat

selectChat(sessionId?: string): Promise<void>
Parameters
- OptionalsessionId: string
Returns Promise<void>
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:434

`Protected`selectTaskContextWithMarking

selectTaskContextWithMarking(): Promise<undefined | string>
Prompts the user to select a task context with special marking for currently opened files

Returns Promise<undefined | string>
The selected task context ID or undefined if cancelled
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:700

`Protected`setActiveSessionEmpty

setActiveSessionEmpty(empty: boolean): void
Parameters
- empty: boolean
Returns void
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:182

`Protected`summarizeActiveSession

summarizeActiveSession(): Promise<undefined | string>
Returns Promise<undefined | string>
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:650

toggleView

toggleView(): Promise<ChatViewWidget>
Returns Promise<ChatViewWidget>
Inherited from AbstractViewContribution.toggleView
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:40

tryGetWidget

tryGetWidget(): undefined | ChatViewWidget
Returns undefined | ChatViewWidget
Inherited from AbstractViewContribution.tryGetWidget
- Defined in packages/core/lib/browser/shell/view-contribution.d.ts:36

`Protected`updateChatViewActiveKey

updateChatViewActiveKey(): void
Returns void
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:157

`Protected`withWidget

withWidget(
widget?: undefined | Widget,
predicate?: (output: ChatViewWidget) => boolean,
): boolean
Parameters
- widget: undefined | Widget = ...
- predicate: (output: ChatViewWidget) => boolean = ...
Returns boolean
- Defined in packages/ai-chat-ui/src/browser/ai-chat-ui-contribution.ts:635

Class AIChatContribution

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns AIChatContribution

Properties

Protected ReadonlyactivationService

ProtectedactiveSessionEmpty

ProtectedactiveSessionModelListener

Protected ReadonlychatAgentService

Protected ReadonlychatService

ProtectedchatViewActiveKey

Protected ReadonlycontextKeyService

Protected ReadonlyeditorManager

ProtectedhasPersistedSessions

Protected Readonlylogger

Protected ReadonlymessageService

ReadonlyonActiveSessionEmptyChanged

Protected ReadonlyonActiveSessionEmptyChangedEmitter

Protected Readonlyoptions

Protected ReadonlypreferenceService

Protected ReadonlyquickInputService

Protected ReadonlyquickView

Protected ReadonlysecondaryWindowHandler

Protected Readonlyshell

Protected ReadonlytaskContextService

Optional ReadonlytoggleCommand

Protected ReadonlywidgetManager

Protected Static ReadonlyREMOVE_CHAT_BUTTON

Protected Static ReadonlyRENAME_CHAT_BUTTON

Accessors

defaultViewOptions

Returns ApplicationShell.WidgetOptions

isActiveSessionEmpty

Returns boolean

viewId

Returns string

viewLabel

Returns string

widget

Returns Promise<T>

Methods

ProtectedaskForChatSession

Returns Promise<undefined | QuickPickItem>

ProtectedattachToActiveSession

Returns void

canExtractChatView

Parameters

Returns boolean

ProtectedcheckPersistedSessions

Returns Promise<void>

closeView

Returns Promise<undefined | ChatViewWidget>

ProtecteddeleteSession

Parameters

Returns Promise<void>

ProtectedextractChatView

Parameters

Returns void

ProtectedgetOpenedTaskContextFiles

Returns { activeId?: string; openedIds: string[] }

initialize

Returns void

initializeLayout

Returns Promise<void>

openView

Parameters

Returns Promise<ChatViewWidget>

registerCommands

Parameters

Returns void

registerKeybindings

Parameters

Returns void

`Protected` `Readonly`activationService

`Protected`activeSessionEmpty

`Protected`activeSessionModelListener

`Protected` `Readonly`chatAgentService

`Protected` `Readonly`chatService

`Protected`chatViewActiveKey

`Protected` `Readonly`contextKeyService

`Protected` `Readonly`editorManager

`Protected`hasPersistedSessions

`Protected` `Readonly`logger

`Protected` `Readonly`messageService

`Readonly`onActiveSessionEmptyChanged

`Protected` `Readonly`onActiveSessionEmptyChangedEmitter

`Protected` `Readonly`options

`Protected` `Readonly`preferenceService

`Protected` `Readonly`quickInputService

`Protected` `Readonly`quickView

`Protected` `Readonly`secondaryWindowHandler

`Protected` `Readonly`shell

`Protected` `Readonly`taskContextService

`Optional` `Readonly`toggleCommand

`Protected` `Readonly`widgetManager

`Protected` `Static` `Readonly`REMOVE_CHAT_BUTTON

`Protected` `Static` `Readonly`RENAME_CHAT_BUTTON

`Protected`askForChatSession

`Protected`attachToActiveSession

`Protected`checkPersistedSessions

`Protected`deleteSession

`Protected`extractChatView

`Protected`getOpenedTaskContextFiles

`Protected`renameSession

`Protected`selectAgent

`Protected`selectChat

`Protected`selectTaskContextWithMarking

`Protected`setActiveSessionEmpty

`Protected`summarizeActiveSession

`Protected`updateChatViewActiveKey

`Protected`withWidget