Member Junction
    Preparing search index...

    Interface WhiteboardToolResult

    Result payload (serialized to JSON) returned from every whiteboard tool call.

    interface WhiteboardToolResult {
        actions?: WhiteboardToolWidgetAction[];
        answered?: { at: string; data: WhiteboardToolJSONValue };
        error?: string;
        errorCode?: WhiteboardWidgetErrorCode;
        itemId?: string;
        outline?: string;
        pageId?: string;
        result?: WhiteboardToolJSONValue;
        state?: string;
        steps?: WhiteboardToolWidgetStepResult[];
        submitted?: WhiteboardToolJSONValue;
        success: boolean;
        summary?: string;
    }
    Index

    Properties

    actions? answered? error? errorCode? itemId? outline? pageId? result? state? steps? submitted? success summary?

    Properties

    actions?: WhiteboardToolWidgetAction[]

    Inspect: the actions the widget registered (call them with Whiteboard_CallWidget).

    answered?: { at: string; data: WhiteboardToolJSONValue }

    Inspect: the widget's last submit, when one was captured.

    error?: string

    Error description when success is false.

    errorCode?: WhiteboardWidgetErrorCode

    Machine-readable failure code (widget tools; the field name matches the realtime runtime's legacy errorCode). Absent on success and on board-tool failures.

    itemId?: string

    ID of the item the tool created / mutated (when applicable).

    outline?: string

    Widget tools: the widget's outline (inspect, and the post-operate outline). Untrusted widget text.

    pageId?: string

    ID of the page the tool created / switched to / renamed (page tools only).

    result?: WhiteboardToolJSONValue

    Call: the action handler's return value (null when it returned nothing).

    state?: string

    Inspect: the widget's declared state JSON (clipped), when it uses the state API.

    steps?: WhiteboardToolWidgetStepResult[]

    Operate: one entry per attempted step (stops after the first failure).

    submitted?: WhiteboardToolJSONValue

    Operate: the data a submit triggered by the steps carried (the agent submitted it — no note follows).

    success: boolean
    summary?: string

    Human summary the model can narrate ("Added a sticky note …").

    Settings

    Member Visibility

    On This Page

    Properties