Struct ruma::api::client::room::create_room::v3::IncomingRequest
source · [−]pub struct IncomingRequest {
pub creation_content: Option<Raw<CreationContent>>,
pub initial_state: Vec<Raw<AnyInitialStateEvent>, Global>,
pub invite: Vec<OwnedUserId, Global>,
pub invite_3pid: Vec<IncomingInvite3pid, Global>,
pub is_direct: bool,
pub name: Option<String>,
pub power_level_content_override: Option<Raw<RoomPowerLevelsEventContent>>,
pub preset: Option<RoomPreset>,
pub room_alias_name: Option<String>,
pub room_version: Option<RoomVersionId>,
pub topic: Option<String>,
pub visibility: Visibility,
}
client-api-c
or client-api-s
) and (crate features client
or server
) and crate feature api
only.Expand description
‘Incoming’ variant of Request.
Fields
creation_content: Option<Raw<CreationContent>>
Extra keys to be added to the content of the m.room.create
.
initial_state: Vec<Raw<AnyInitialStateEvent>, Global>
List of state events to send to the new room.
Takes precedence over events set by preset, but gets overridden by name and topic keys.
invite: Vec<OwnedUserId, Global>
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<IncomingInvite3pid, Global>
List of third party IDs of users to invite.
is_direct: 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<Raw<RoomPowerLevelsEventContent>>
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<RoomVersionId>
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: 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. Defaults to
Private
.
Trait Implementations
sourceimpl Debug for IncomingRequest
impl Debug for IncomingRequest
sourceimpl IncomingRequest for IncomingRequest
Available on crate feature server
only.
impl IncomingRequest for IncomingRequest
server
only.type EndpointError = Error
type EndpointError = Error
type OutgoingResponse = Response
type OutgoingResponse = Response
sourcefn try_from_http_request<B, S>(
request: Request<B>,
path_args: &[S]
) -> Result<IncomingRequest, FromHttpRequestError>where
B: AsRef<[u8]>,
S: AsRef<str>,
fn try_from_http_request<B, S>(
request: Request<B>,
path_args: &[S]
) -> Result<IncomingRequest, FromHttpRequestError>where
B: AsRef<[u8]>,
S: AsRef<str>,
http::Request
into this request type,
together with the corresponding path arguments. Read more