Struct ruma_client_api::membership::join_room_by_id::v3::Request

#[non_exhaustive]
pub struct Request<'a> {
    pub room_id: &'a RoomId,
    pub third_party_signed: Option<ThirdPartySigned<'a>>,
    pub reason: Option<&'a str>,
}

Data for a request to the join_room_by_id API endpoint.

Join a room using its ID.

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: &'a RoomId

The room where the user should be invited.

third_party_signed: Option<ThirdPartySigned<'a>>

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<&'a str>

Optional reason for joining the room.

Implementations

impl<'a> Request<'a>

pub fn new(room_id: &'a RoomId) -> Self

Creates a new Request with the given room id.

Trait Implementations

impl<'a> Clone for Request<'a>

fn clone(&self) -> Request<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.

impl<'a> OutgoingRequest for Request<'a>

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 = self::METADATA

Metadata about the endpoint.

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

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