Interface WhiteboardWidgetReply

A validated reply to one command.

interface WhiteboardWidgetReply {
    Code?: WhiteboardWidgetErrorCode;
    Error?: string;
    ID: string;
    Ok: boolean;
    Result?: WhiteboardToolJSONValue;
}

Index

Properties

Code? Error? ID Ok Result?

Properties

`Optional`Code

Code?: WhiteboardWidgetErrorCode

Machine-readable failure code, when the helper supplied a known one.

`Optional`Error

Error?: string

Failure description (present when not Ok).

ID

ID: string

The correlation id of the command this answers.

Ok

Ok: boolean

Whether the command succeeded.

`Optional`Result

Result?: WhiteboardToolJSONValue

The op-specific result (present when Ok).