Struct Request

#[non_exhaustive]
pub struct Request {
    pub room_id: OwnedRoomId,
    pub kind: StateEventType,
    pub sender: OwnedUserId,
    pub state_key: OwnedUserId,
    pub content: Raw<RoomMemberEventContent>,
}

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

Request type for the exchange_invite 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 ID to exchange the third-party invite in.

kind: StateEventType

The event type.

Must be StateEventType::RoomMember.

sender: OwnedUserId

The user ID of the user who sent the original invite event.

state_key: OwnedUserId

The user ID of the invited user.

content: Raw<RoomMemberEventContent>

The content of the invite event.

It must have a membership of invite and the third_party_invite field must be set.

Implementations

impl Request

pub fn new( room_id: OwnedRoomId, sender: OwnedUserId, state_key: OwnedUserId, content: Raw<RoomMemberEventContent>, ) -> Request

Creates a new Request for a third-party invite exchange.

pub fn with_third_party_invite( room_id: OwnedRoomId, sender: OwnedUserId, state_key: OwnedUserId, third_party_invite: ThirdPartyInvite, ) -> Result<Request, Error>

Creates a new Request for a third-party invite exchange from a ThirdPartyInvite.

Returns an error if the serialization of the event content fails.

pub fn with_bind_callback_request_and_event( bind_callback_invite: ThirdPartyInvite, room_third_party_invite_event: &RoomThirdPartyInviteEventContent, ) -> Result<Request, Error>

Creates a new Request for a third-party invite exchange from a ThirdPartyInvite in the bind_callback::v1::Request and the matching RoomThirdPartyInviteEventContent.

Returns an error if the serialization of the event content fails.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Request

Returns a duplicate 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 IncomingRequest for Request

const METADATA: Metadata = METADATA

Metadata about the endpoint.

type EndpointError = MatrixError

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.

fn try_from_http_request<B, S>( request: Request<B>, path_args: &[S], ) -> Result<Request, 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.

impl OutgoingRequest for Request

const METADATA: Metadata = METADATA

Metadata about the endpoint.

type EndpointError = MatrixError

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

type IncomingResponse = Response

Response type returned when the request is successful.

fn try_into_http_request<T>( self, base_url: &str, access_token: SendAccessToken<'_>, considering: &SupportedVersions, ) -> Result<Request<T>, IntoHttpError>

where T: Default + BufMut,

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

fn is_supported(considering_versions: &SupportedVersions) -> bool

Whether the homeserver advertises support for this endpoint.