Home / @sym20/core-conversations / IRoomSettingsCreate

IRoomSettingsCreate interface

Settings configuration used when creating a room. Properties that are not specified will be set to default values. TODO: specify default values.

Signature
export interface IRoomSettingsCreate 

Properties

PropertyTypeDescription
copyProtectedboolean

TODO

discoverableboolean

How the room is handled in search results. * true - The room is always included in search results. * false - The room is only included in search results for its members.

externalboolean

TODO

membersCanAddUsersboolean

Determines who can add members and accept/deny join requests to the room. * true - All members of the room can add members and accept/deny join requests. * false - Only owners of the room can add members and accept/deny join requests.

publicboolean

readOnlyboolean

Determines who can send messages in the room. * true - Only owners of the room can send messages. * false - All members of the room can send messages.

simplifiedboolean

Whether the room supports a simplified UI view. A client is supposed to show a simplified conversation with less options to change settings, and a simplified view for creating conversations can be shown where the user has to enter only the other members to add. If the room is simplified it has a few effects on the room's behaviour: - The room can have a maximum of eight members. - All members of the room is by default an owner of it. - If the room's name is set, the room is turned into a non-simplified room.

viewHistoryboolean

How the conversation history is handled when new members are added. * true - The conversation history is available to newly added members. * false - A member will not be able to see any conversation messages prior to the point in time of the join.