IConversationStore.createRoom() method
Create a new room
Signature
createRoom(name: string, description: string, members: UserId[], settings: Partial<IRoomSettingsCreate>): Promise<IConversationRoom>;
Remarks
The initial members will be the current user and all users given in the members
aegument.
Parameters
Parameter | Type | Description |
---|---|---|
name | string | Name of the new conversation |
description | string | Description of the conversation |
members | UserId[] | Initial members of the conversation |
settings | Partial<IRoomSettingsCreate> | Initial settings of the conversation. Any setting that is not included will have default values. |
Returns
Type | Description |
---|---|
Promise<IConversationRoom> | The created conversation |
Throws
Error |
---|