Skip to main content

Session canvas

Scope: SessionRpc (per-session operations tied to a Session) For an overview of RPC and the list of all RPC pages, see RPC.

Session canvas

Call the Canvas RPCs from $session->rpc()->canvas(). list() returns the list in canvases of a CanvasList, and listOpen() returns it in openCanvases of a CanvasListOpenResult. open() returns an OpenCanvasInstance, and action invocations return a CanvasActionInvokeResult. close() has no return value.
Canvas provider reverse-RPCs (canvas.open / canvas.close / canvas.action.invoke) are handled by canvasHandler in SessionConfig / ResumeSessionConfig. Rendering the canvas is the responsibility of the host UI.
Last modified on November 19, 2026