Class IFrameClientServicesProxy

_{Declared in packages/sdk/client/dist/types/src/packlets/client/iframe-service-proxy.d.ts:15}

Proxy to host client service via iframe.

Constructors

constructor([options])

Returns: IFrameClientServicesProxy

Arguments:

options: Partial<IFrameClientServicesProxyOptions>

Properties

joinedSpace

Type: Event<PublicKey>

contextUpdate

Type: undefined | Event<AppContextRequest>

descriptors

Type: ServiceBundle<ClientServices>

display

Type: undefined | ShellDisplay

proxy

Type: ProtoRpcPeer<ClientServices>

services

Type: ClientServices

Methods

close()

Returns: Promise<void>

Arguments: none

open()

Returns: Promise<void>

Arguments: none

setLayout(layout, [options])

Returns: Promise<void>

Arguments:

layout: ShellLayout

options: Omit<LayoutRequest, "layout">

setSpaceProvider(provider)

Returns: void

Arguments:

provider: Provider<undefined | PublicKey>