CreateRoomParams

@JsonClass(generateAdapter = true)
open class CreateRoomParams

Constructors

Link copied to clipboard
fun CreateRoomParams()

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
fun enableEncryption()
Link copied to clipboard
fun setDirectMessage()

Mark as a direct message room.

Properties

Link copied to clipboard
var algorithm: String? = null

Supported value: MXCRYPTO_ALGORITHM_MEGOLM.

Link copied to clipboard
var avatarUri: Uri? = null

If this is not null, the image uri will be sent to the media server and will be set as a room avatar.

Link copied to clipboard
var creationContent: MutableMap<String, Any>

Extra keys to be added to the content of the m.room.create. The server will clobber the following keys: creator. Future versions of the specification may allow the server to clobber other keys.

Link copied to clipboard
var disableFederation: Boolean = false

Set to true to disable federation of this room. Default: false

Link copied to clipboard
var enableEncryptionIfInvitedUsersSupportIt: Boolean = false

If set to true, when the room will be created, if cross-signing is enabled and we can get keys for every invited users, the encryption will be enabled on the created room.

Link copied to clipboard
var featurePreset: RoomFeaturePreset? = null
Link copied to clipboard
var guestAccess: GuestAccess? = null

Initial Guest Access.

Link copied to clipboard
var historyVisibility: RoomHistoryVisibility? = null
Link copied to clipboard
var initialStates: MutableList<CreateRoomStateEvent>

A list of state events to set in the new room. This allows the user to override the default state events set in the new room. The expected format of the state events are an object with type, state_key and content keys set. Takes precedence over events set by preset, but gets overridden by name and topic keys.

Link copied to clipboard
var invite3pids: MutableList<ThreePid>

A list of objects representing third party IDs to invite into the room.

Link copied to clipboard
var invitedUserIds: MutableList<String>

A list of user IDs to invite to the room. This will tell the server to invite everyone in the list to the newly created room.

Link copied to clipboard
var isDirect: Boolean? = null

This flag makes the server set the is_direct flag on the m.room.member events sent to the users in invite and invite_3pid. See Direct Messaging for more information.

Link copied to clipboard
var name: String? = null

If this is not null, an m.room.name event will be sent into the room to indicate the name of the room. See Room Events for more information on m.room.name.

Link copied to clipboard
var powerLevelContentOverride: PowerLevelsContent? = null

The power level content to override in the default power level event.

Link copied to clipboard
var preset: CreateRoomPreset? = null

Convenience parameter for setting various default state events based on a preset. Must be either: private_chat => join_rules is set to invite. history_visibility is set to shared. trusted_private_chat => join_rules is set to invite. history_visibility is set to shared. All invitees are given the same power level as the room creator. public_chat: => join_rules is set to public. history_visibility is set to shared.

Link copied to clipboard
var roomAliasName: String? = null

The desired room alias local part. If this is included, a room alias will be created and mapped to the newly created room. The alias will belong on the same homeserver which created the room. For example, if this was set to "foo" and sent to the homeserver "example.com" the complete room alias would be #foo:example.com.

Link copied to clipboard
var roomType: String? = null
Link copied to clipboard
var roomVersion: String? = null
Link copied to clipboard
var topic: String? = null

If this is not null, an m.room.topic event will be sent into the room to indicate the topic for the room. See Room Events for more information on m.room.topic.

Link copied to clipboard
var visibility: RoomDirectoryVisibility? = null

A public visibility indicates that the room will be shown in the published room list. A private visibility will hide the room from the published room list. Rooms default to private visibility if this key is not included. NB: This should not be confused with join_rules which also uses the word public. One of: "public", "private"

Inheritors

Link copied to clipboard