Struct ruma::api::client::membership::join_room_by_id_or_alias::v3::IncomingRequest

pub struct IncomingRequest {
    pub room_id_or_alias: OwnedRoomOrAliasId,
    pub server_name: Vec<OwnedServerName, Global>,
    pub third_party_signed: Option<IncomingThirdPartySigned>,
    pub reason: Option<String>,
}

Available on (crate features client-api-c or client-api-s) and (crate features client or server) and crate feature api only.

‘Incoming’ variant of Request.

Fields

room_id_or_alias: OwnedRoomOrAliasId

The room where the user should be invited.

server_name: Vec<OwnedServerName, Global>

The servers to attempt to join the room through.

One of the servers must be participating in the room.

third_party_signed: Option<IncomingThirdPartySigned>

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.

Trait Implementations

impl Debug for IncomingRequest

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

Formats the value using the given formatter.

impl IncomingRequest for IncomingRequest

Available on crate feature server only.

type EndpointError = Error

A type capturing the error conditions that can be returned in the response.

type OutgoingResponse = Response

Response type to return when the request is successful.

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

fn try_from_http_request<B, S>(
    request: Request<B>,
    path_args: &[S]
) -> Result<IncomingRequest, FromHttpRequestError>where
    B: AsRef<[u8]>,
    S: AsRef<str>,

Tries to turn the given http::Request into this request type, together with the corresponding path arguments.