Interface ChangeSetElementArgs

interface ChangeSetElementArgs {
    additionalInfo?: string;
    changeSet: ChangeSetImpl;
    chatSessionId: string;
    data?: {
        [key: string]: unknown;
    };
    icon?: string;
    name?: string;
    onDidChange?: Event<void>;
    replacements?: Replacement[];
    state?: "pending" | "applied" | "stale";
    targetState?: string;
    type?: "add" | "modify" | "delete";
    uri: URI;
    apply?(): Promise<void>;
    dispose?(): void;
    open?(): Promise<void>;
    openChange?(): Promise<void>;
    revert?(): Promise<void>;
}

Hierarchy

Properties

additionalInfo? changeSet chatSessionId data? icon? name? onDidChange? replacements? state? targetState? type? uri

Methods

apply? dispose? open? openChange? revert?

Properties

Optional Readonly additionalInfo

additionalInfo?: string

changeSet

changeSet: ChangeSetImpl

The change set containing this element.

chatSessionId

chatSessionId: string

The id of the chat session containing this change set element.

Optional Readonly data

data?: {
    [key: string]: unknown;
}

Type declaration

  • [key: string]: unknown

Optional Readonly icon

icon?: string

Optional Readonly name

name?: string

Optional onDidChange

onDidChange?: Event<void>

Optional replacements

replacements?: Replacement[]

An array of replacements used to create the new content for the targetState. This is only available if the agent was able to provide replacements and we were able to apply them.

Optional Readonly state

state?: "pending" | "applied" | "stale"

Optional targetState

targetState?: string

The state of the file after the changes have been applied. If undefined, there is no change.

Optional Readonly type

type?: "add" | "modify" | "delete"

uri

uri: URI

The URI of the element, expected to be unique within the same change set.

Methods

Optional apply

Optional dispose

Optional open

Optional openChange

Optional revert

Settings

Member Visibility

Theme

On This Page

additionalInfochangeSetchatSessionIddataiconnameonDidChangereplacementsstatetargetStatetypeuriapplydisposeopenopenChangerevert