Struct Request

#[non_exhaustive]
pub struct Request {
    pub medium: Medium,
    pub address: String,
    pub room_id: OwnedRoomId,
    pub sender: OwnedUserId,
    pub room_alias: Option<OwnedRoomAliasId>,
    pub room_avatar_url: Option<OwnedMxcUri>,
    pub room_join_rules: Option<String>,
    pub room_name: Option<String>,
    pub room_type: Option<RoomType>,
    pub sender_display_name: Option<String>,
    pub sender_avatar_url: Option<OwnedMxcUri>,
}

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

Request type for the store_invitation 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.

medium: Medium

The type of the third party identifier for the invited user.

Currently, only Medium::Email is supported.

address: String

The email address of the invited user.

room_id: OwnedRoomId

The Matrix room ID to which the user is invited.

sender: OwnedUserId

The Matrix user ID of the inviting user.

room_alias: Option<OwnedRoomAliasId>

The Matrix room alias for the room to which the user is invited.

This should be retrieved from the m.room.canonical state event.

room_avatar_url: Option<OwnedMxcUri>

The Content URI for the room to which the user is invited.

This should be retrieved from the m.room.avatar state event.

room_join_rules: Option<String>

The join_rule for the room to which the user is invited.

This should be retrieved from the m.room.join_rules state event.

room_name: Option<String>

The name of the room to which the user is invited.

This should be retrieved from the m.room.name state event.

room_type: Option<RoomType>

The type of the room to which the user is invited.

This should be retrieved from the m.room.create state event.

sender_display_name: Option<String>

The display name of the user ID initiating the invite.

sender_avatar_url: Option<OwnedMxcUri>

The Content URI for the avater of the user ID initiating the invite.

Implementations

impl Request

pub fn new( medium: Medium, address: String, room_id: OwnedRoomId, sender: OwnedUserId, ) -> Request

Creates a new `Request with the given medium, email address, room ID and sender.

pub fn email( address: String, room_id: OwnedRoomId, sender: OwnedUserId, ) -> Request

Creates a new Request with the given email address, room ID and sender.

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 IncomingRequest for Request

Available on crate feature server only.

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

Available on crate feature client only.

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_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>

where T: Default + BufMut,

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