Struct ruma::api::client::membership::join_room_by_id::v3::Request

#[non_exhaustive]
pub struct Request {
    pub room_id: OwnedRoomId,
    pub third_party_signed: Option<ThirdPartySigned>,
    pub reason: Option<String>,
}

Request type for the join_room_by_id endpoint.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

room_id: OwnedRoomId

The room where the user should be invited.

third_party_signed: Option<ThirdPartySigned>

The signature of a m.third_party_invite token to prove that this user owns a third party identity which has been invited to the room.

reason: Option<String>

Optional reason for joining the room.

Implementations

impl Request

pub fn new(room_id: OwnedRoomId) -> Request

Creates a new Request with the given room id.

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<(), Error>

Formats the value using the given formatter.

impl OutgoingRequest for Request

type EndpointError = Error

A type capturing the expected error conditions the server can return.

type IncomingResponse = Response

Response type returned when the request is successful.

const METADATA: Metadata = METADATA

Metadata about the endpoint.

fn try_into_http_request<T>( self, base_url: &str, access_token: SendAccessToken<'_>, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>

where T: Default + BufMut,

Tries to convert this request into an http::Request.