Interface IDumpCellResponse

Response to 'dumpCell' request. This is an addition to the Debug Adapter Protocol to support setting breakpoints for cells.

interface IDumpCellResponse {
    body: { sourcePath: string };
    command: string;
    message?: string;
    request_seq: number;
    seq: number;
    success: boolean;
    type: string;
}

Hierarchy

  • Response
    • IDumpCellResponse

Properties

body command message? request_seq seq success type

Properties

body

body: { sourcePath: string }

Contains request result if success is true and error details if success is false.

command

command: string

The command requested.

Optionalmessage

message?: string

Contains the raw error in short form if success is false. This raw error might be interpreted by the client and is not shown in the UI. Some predefined values exist. Values: 'cancelled': the request was cancelled. 'notStopped': the request may be retried once the adapter is in a 'stopped' state. etc.

request_seq

request_seq: number

Sequence number of the corresponding request.

seq

seq: number

Sequence number of the message (also known as message ID). The seq for the first message sent by a client or debug adapter is 1, and for each subsequent message is 1 greater than the previous message sent by that actor. seq can be used to order requests, responses, and events, and to associate requests with their corresponding responses. For protocol messages of type request the sequence number can be used to cancel the request.

success

success: boolean

Outcome of the request. If true, the request was successful and the body attribute may contain the result of the request. If the value is false, the attribute message contains the error in short form and the body may contain additional information (see ErrorResponse.body.error).

type

type: string

Message type. Values: 'request', 'response', 'event', etc.

Settings

Member Visibility

On This Page

Properties