Classes
Methods
# async addChildRoom(roomId, childOpts) → {Promise.<void>}
Adds a child room to the space. Must be joined to both the room and the space.
Parameters:
| Name | Type | Description |
|---|---|---|
roomId |
string
|
The room ID to add. |
childOpts |
SpaceChildEntityOptions
|
Additional options for the child space. |
Resolves when complete.
Promise.<void>
# async addChildSpace(space, childOpts) → {Promise.<Space>}
Adds a child space to the space. Must be joined to both spaces.
Parameters:
| Name | Type | Description |
|---|---|---|
space |
Space
|
The space to add. |
childOpts |
SpaceChildEntityOptions
|
Related options for the child's representation. |
Resolves when complete.
Promise.<Space>
# async createChildSpace(opts) → {Promise.<Space>}
Creates a new child space under this space.
Parameters:
| Name | Type | Description |
|---|---|---|
opts |
SpaceCreateOptions
|
The options for the new space. |
Resolves to the created space.
Promise.<Space>
# async getChildEntities() → {Promise.<SpaceEntityMap>}
Gets all the child rooms on the space. These may be spaces or other rooms.
Resolves to a map of children for this space.
Promise.<SpaceEntityMap>
# async inviteUser(userId) → {Promise.<void>}
Invite a user to the current space.
Parameters:
| Name | Type | Description |
|---|---|---|
userId |
string
|
The user ID to invite. |
Resolves when completed.
Promise.<void>
# async removeChildRoom(roomId) → {Promise.<void>}
Removes a child room from the space. Must be joined to the current space (not needed for child room).
Parameters:
| Name | Type | Description |
|---|---|---|
roomId |
string
|
The room ID to remove. |
Resolves when complete.
Promise.<void>