@dxos/react-client
    Preparing search index...

    Class Shell

    Interface for controlling the shell.

    Index

    Constructors

    constructor

    Accessors

    display

    Methods

    createIdentity joinIdentity joinSpace onDisplayChange onReset open recoverIdentity setInvitationUrl shareIdentity shareSpace

    Constructors

    • Parameters

      • __namedParameters: ShellParams

      Returns Shell

    Accessors

    Methods

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

      Returns Promise<InitializeIdentityResult>

      Shell result with the new identity.

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

      Parameters

      • Optional__namedParameters: { invitationCode?: string }

      Returns Promise<InitializeIdentityResult>

      Shell result with the new identity.

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

      Parameters

      • Optional__namedParameters: { invitationCode?: string }

      Returns Promise<JoinSpaceResult>

      The joined space.

      If no identity exists.

    • Listen for changes to the shell display.

      Parameters

      Returns CleanupFn

    • Listen for reset event.

      Parameters

      • cb: (target?: string) => void

      Returns CleanupFn

    • Open the shell with the given layout.

      Parameters

      Returns Promise<void>

    • Initialize a new device with an existing identity using a recovery code.

      Returns Promise<InitializeIdentityResult>

      Shell result with the identity.

    • Parameters

      • request: {
            deviceInvitationParam: string;
            invitationUrl: string;
            spaceInvitationParam: string;
        }

      Returns Promise<void>

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

      Returns Promise<ShareIdentityResult>

      Shell result with the new device.

    • 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.

      Parameters

      • __namedParameters: { spaceId?: string; spaceKey?: PublicKey; target?: string }

      Returns Promise<ShareSpaceResult>

      Shell result with any new members that join while the shell is open.

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods