Method on_open

python/copilot/canvas.py:152–157

Open a new canvas instance. May raise :class:`CanvasError` to surface a structured failure to the host.

(self, ctx: CanvasProviderOpenRequest)

    @abstractmethod
    async def on_open(self, ctx: CanvasProviderOpenRequest) -> CanvasProviderOpenResult:
        """Open a new canvas instance.

        May raise :class:`CanvasError` to surface a structured failure to
        the host.
        """

    async def on_close(self, ctx: CanvasProviderCloseRequest) -> None:
        """Canvas was closed by the user or agent. Default: no-op."""