Class Shell

_{Declared in packages/sdk/client/src/services/shell.ts:46}

Interface for controlling the shell.

Constructors

constructor(options)

Returns: Shell

Arguments:

options: ShellParams

Properties

display

Type: ShellDisplay

Methods

createIdentity()

Create a new identity. Opens the shell and starts the identity creation flow.

Returns: Promise<InitializeIdentityResult>

Arguments: none

joinIdentity(options)

Join an existing identity. Opens the shell and starts the device invitation flow based on the given options.

Returns: Promise<InitializeIdentityResult>

Arguments:

options: object

joinSpace(options)

Join an existing space. Opens the shell and starts the space join flow based on the given options.

Returns: Promise<JoinSpaceResult>

Arguments:

options: object

onDisplayChange(cb)

Listen for changes to the shell display.

Returns: UnsubscribeCallback

Arguments:

cb: function

open(layout, options)

Open the shell with the given layout.

Returns: Promise<void>

Arguments:

layout: ShellLayout

options: Omit<LayoutRequest, "layout">

setInvitationUrl(request)

Returns: Promise<void>

Arguments:

request: object

shareIdentity()

Invite a new device to join the current identity. Opens the shell and presents a device invitation.

Returns: Promise<ShareIdentityResult>

Arguments: none

shareSpace(options)

Invite new members to join the current space. Opens the shell to the specified space, showing current members and allowing new members to be invited.

Returns: Promise<ShareSpaceResult>

Arguments:

options: object