Struct ruma_identity_service_api::invitation::store_invitation::v2::IncomingRequest

pub struct IncomingRequest {
    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>,
}

‘Incoming’ variant of Request.

Fields

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.

Trait Implementations

impl Debug for IncomingRequest

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

Formats the value using the given formatter.

impl IncomingRequest for IncomingRequest

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.

const METADATA: Metadata = self::METADATA

Metadata about the endpoint.

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