Struct ruma::api::identity_service::invitation::store_invitation::v2::IncomingRequest [−][src]
pub struct IncomingRequest {
pub medium: Medium,
pub address: String,
pub room_id: RoomId,
pub sender: UserId,
pub room_alias: Option<RoomAliasId>,
pub room_avatar_url: Option<MxcUri>,
pub room_join_rules: Option<String>,
pub room_name: Option<Box<RoomName, Global>>,
pub sender_display_name: Option<String>,
pub sender_avatar_url: Option<MxcUri>,
}
api
and (crate features identity-service-api
or identity-service-api-c
or identity-service-api-s
) only.Expand description
‘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: RoomId
The Matrix room ID to which the user is invited.
sender: UserId
The Matrix user ID of the inviting user.
room_alias: Option<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<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<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<Box<RoomName, Global>>
The name of the room to which the user is invited.
This should be retrieved from the m.room.name
state event.
sender_display_name: Option<String>
The display name of the user ID initiating the invite.
sender_avatar_url: Option<MxcUri>
The Content URI for the avater of the user ID initiating the invite.
Trait Implementations
type EndpointError = MatrixError
type EndpointError = MatrixError
A type capturing the error conditions that can be returned in the response.
type OutgoingResponse = Response
type OutgoingResponse = Response
Response type to return when the request is successful.
pub fn try_from_http_request<T>(
request: Request<T>
) -> Result<IncomingRequest, FromHttpRequestError> where
T: AsRef<[u8]>,
pub fn try_from_http_request<T>(
request: Request<T>
) -> Result<IncomingRequest, FromHttpRequestError> where
T: AsRef<[u8]>,
Tries to turn the given http::Request
into this request type.
Auto Trait Implementations
impl RefUnwindSafe for IncomingRequest
impl Send for IncomingRequest
impl Sync for IncomingRequest
impl Unpin for IncomingRequest
impl UnwindSafe for IncomingRequest
Blanket Implementations
Mutably borrows from an owned value. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
type Output = T
type Output = T
Should always be Self
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more