View source

typedef ChatParticipant

package vscode

A chat participant can be invoked by the user in a chat session, using the @ prefix. When it is invoked, it handles the chat request and is solely responsible for providing a response to the user. A ChatParticipant is created using {@link chat.createChatParticipant}.

Fields

requestHandler:ChatRequestHandler

The handler for requests to this participant.

onDidReceiveFeedback:Event<ChatResultFeedback>

An event that fires whenever feedback for a result is received, e.g. when a user up- or down-votes a result.

The passed {@link ChatResultFeedback.result result} is guaranteed to have the same properties as the result that was previously returned from this chat participant's handler.

read onlyid:String

A unique ID for this participant.

@:optionaloptionaliconPath:Null<IconPath>

An icon for the participant shown in UI.

@:optionaloptionalfollowupProvider:Null<ChatFollowupProvider>

This provider will be called once after each request to retrieve suggested followup questions.

dispose():Void

Dispose this participant and free resources.