Struct ruma::api::identity_service::invitation::store_invitation::v2::Request

pub struct Request<'a> {
    pub medium: &'a Medium,
    pub address: &'a str,
    pub room_id: &'a RoomId,
    pub sender: &'a UserId,
    pub room_alias: Option<&'a RoomAliasId>,
    pub room_avatar_url: Option<&'a MxcUri>,
    pub room_join_rules: Option<&'a str>,
    pub room_name: Option<&'a str>,
    pub room_type: Option<&'a RoomType>,
    pub sender_display_name: Option<&'a str>,
    pub sender_avatar_url: Option<&'a MxcUri>,
}

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

Data for a request to the store_invitation API endpoint.

Store pending invitations to a user’s 3PID.

Fields

medium: &'a Medium

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

Currently, only Medium::Email is supported.

address: &'a str

The email address of the invited user.

room_id: &'a RoomId

The Matrix room ID to which the user is invited.

sender: &'a UserId

The Matrix user ID of the inviting user.

room_alias: Option<&'a RoomAliasId>

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

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

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

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

The display name of the user ID initiating the invite.

sender_avatar_url: Option<&'a MxcUri>

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

Implementations

impl<'a> Request<'a>

pub fn new(
    medium: &'a Medium,
    address: &'a str,
    room_id: &'a RoomId,
    sender: &'a UserId
) -> Request<'a>

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

pub fn email(
    address: &'a str,
    room_id: &'a RoomId,
    sender: &'a UserId
) -> Request<'a>

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

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

Formats the value using the given formatter.

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

Available on crate feature client only.

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.

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