Home / @sym20/core-conversations / IConversationStore / createRoom

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

ParameterTypeDescription
namestring

Name of the new conversation

descriptionstring

Description of the conversation

membersUserId[]

Initial members of the conversation

settingsPartial<IRoomSettingsCreate>

Initial settings of the conversation. Any setting that is not included will have default values.

Returns

TypeDescription
Promise<IConversationRoom>

The created conversation

Throws

Error

RoomNameNotUnique

RoomNameTooLong

TooManyMembersInConversation

InactiveMembersInConversation

UserNotEntitled

InformationBarrierViolation

UserConnectionMissing

UserInactive