Theia API Documentation v1.66.0
    Preparing search index...

    Interface ChangeSetElementArgs

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

    Hierarchy

    Index

    Properties

    additionalInfo? apply? chatSessionId data? dispose? icon? name? onDidChange? onHide? onShow? open? openChange? originalState? replacements? requestId revert? state? targetState? toSerializable? type? uri

    Properties

    additionalInfo?: string
    apply?: () => Promise<void>
    chatSessionId: string

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

    data?: { [key: string]: unknown }
    dispose?: () => void
    icon?: string
    name?: string
    onDidChange?: Event<void>
    onHide?: () => void

    Type Declaration

      • (): void

      • Called when an element is hidden in the UI

        Returns void

    onShow?: () => void

    Type Declaration

      • (): void

      • Called when an element is shown in the UI

        Returns void

    open?: () => Promise<void>
    openChange?: () => Promise<void>
    originalState?: string

    The state before the change has been applied. If it is specified, we don't care about the state of the original file on disk but just use the specified originalState. If it isn't specified, we'll derived and observe the state from the file system.

    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.

    requestId: string

    The id of the request with which this change set element is associated.

    revert?: () => Promise<void>
    state?: "pending" | "applied" | "stale"
    targetState?: string

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

    toSerializable?: () => SerializableChangeSetElement

    Type Declaration

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

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

    Settings

    Member Visibility

    On This Page

    Properties