Struct ruma_client_api::r0::room::create_room::Request

pub struct Request {
    pub creation_content: Option<CreationContent>,
    pub initial_state: Vec<InitialStateEvent>,
    pub invite: Vec<UserId>,
    pub invite_3pid: Vec<Invite3pid>,
    pub is_direct: Option<bool>,
    pub name: Option<String>,
    pub power_level_content_override: Option<PowerLevelsEventContent>,
    pub preset: Option<RoomPreset>,
    pub room_alias_name: Option<String>,
    pub room_version: Option<String>,
    pub topic: Option<String>,
    pub visibility: Option<Visibility>,
}

Data for a request to the create_room API endpoint.

Create a new room.

Fields

creation_content: Option<CreationContent>

Extra keys to be added to the content of the m.room.create.

initial_state: Vec<InitialStateEvent>

List of state events to send to the new room.

Takes precedence over events set by preset, but gets overriden by name and topic keys.

invite: Vec<UserId>

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.

invite_3pid: Vec<Invite3pid>

List of third party IDs of users to invite.

is_direct: Option<bool>

If set, this sets the is_direct flag on room invites.

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.

power_level_content_override: Option<PowerLevelsEventContent>

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

preset: Option<RoomPreset>

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

room_alias_name: Option<String>

The desired room alias local part.

room_version: Option<String>

Room version to set for the room. Defaults to homeserver's default if not specified.

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.

visibility: Option<Visibility>

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.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl Endpoint for Request

type Response = Response

Data returned in a successful response from the endpoint.

type ResponseError = Error

Error type returned when response from endpoint fails.

const METADATA: Metadata

Metadata for the #name endpoint.

impl Outgoing for Request

type Incoming = IncomingRequest

The 'Incoming' variant of Self.

impl TryFrom<Request> for Request<Vec<u8>>

type Error = IntoHttpError

The type returned in the event of a conversion error.

fn try_from(request: Request) -> Result<Self, Self::Error>

Performs the conversion.