SpaceHandle

• SpaceHandle

Interface SpaceHandle

Shareable reference to a 3D space.

See

• SpaceAPI.requestSpaceHandle to obtain a space handle for the current space.
• SpaceAPI.openSpace to open a space via a space handle.

interface SpaceHandle {
    roleKey?: string;
    spaceId: string;
    spaceUrl?: string;
}

Index

Properties

roleKey? spaceId spaceUrl?

Properties

OptionalroleKey

roleKey?: string

An optional key of a member role to assign when the space is opened via the handle. Undefined, if the handle was requested without specifying a role. If undefined, the MemberRole.VIEWER role will be assigned when opening the space via the handle.

spaceId

spaceId: string

The ID of the space in which the handle was requested. This is the space that will be opened when using the handle with SpaceAPI.openSpace.

OptionalspaceUrl

spaceUrl?: string

URL that can be used to open the space via the handle. Satisfies the format <HUB_URL>/space/<SPACE_ID>[?roleKey=<ROLE_KEY>], where <HUB_URL> is the URL of the hub, <SPACE_ID> is the ID of the space, and <ROLE_KEY> is an optional key of a member role to assign when opening the space via the handle.