SurfaceHandle
A live embedded surface, returned by Platform.embedSurface. The shell brokers the nested iframe; this handle lets the host re-parameterise it in place (SurfaceHandle.update, no remount), tear it down (SurfaceHandle.close), read its reported height, and await first-ready.
Properties
Section titled “Properties”channelId
Section titled “channelId”readonly channelId: string | null;The surface’s shell-minted channel id; null until the embed is accepted.
height
Section titled “height”readonly height: number;The surface’s last reported content height, in pixels.
readonly ready: Promise<void>;Resolves when the surface has handshaked + rendered; rejects on denial/teardown.
Methods
Section titled “Methods”close()
Section titled “close()”close(): void;Remove the surface and its iframe.
Returns
Section titled “Returns”void
update()
Section titled “update()”update(params): void;Push new params — the surface re-renders in place (no remount).
Parameters
Section titled “Parameters”params
Section titled “params”Record<string, unknown>
Returns
Section titled “Returns”void