Struct gm_types::replies::RoomCreationOptions

pub struct RoomCreationOptions {
    pub visibility: Option<RoomVisibility>,
    pub room_alias_name: Option<String>,
    pub name: Option<String>,
    pub topic: Option<String>,
    pub invite: Vec<String>,
    pub creation_content: HashMap<String, Value>,
    pub preset: Option<RoomPreset>,
    pub is_direct: bool,
}

Options used to create a room.

Fields

visibility: Option<RoomVisibility>

Controls whether the room will be shown in the published room list. NB. Not the same thing as join_rules.

Rooms default to private visibility if this key is not included.

room_alias_name: Option<String>

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.

name: Option<String>

If this is included, an m.room.name event will be sent into the room to indicate the name of the room.

topic: Option<String>

If this is included, an m.room.topic event will be sent into the room to indicate the topic for the room.

invite: Vec<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.

creation_content: HashMap<String, Value>

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.

preset: Option<RoomPreset>

Convenience parameter for setting various default state events based on a preset.

See the RoomPreset docs for more.

is_direct: bool

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.

Trait Implementations

impl Default for RoomCreationOptions

fn default() -> RoomCreationOptions

Returns the "default value" for a type.

impl Clone for RoomCreationOptions

fn clone(&self) -> RoomCreationOptions

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RoomCreationOptions

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Serialize for RoomCreationOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.