Struct ruma_identity_service_api::invitation::store_invitation::v2::Request
source · [−]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>,
}
Expand description
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
Trait Implementations
sourceimpl<'a> OutgoingRequest for Request<'a>
impl<'a> OutgoingRequest for Request<'a>
type EndpointError = MatrixError
type EndpointError = MatrixError
A type capturing the expected error conditions the server can return.
type IncomingResponse = Response
type IncomingResponse = Response
Response type returned when the request is successful.
sourcefn try_into_http_request<T: Default + BufMut>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
considering_versions: &[MatrixVersion]
) -> Result<Request<T>, IntoHttpError>
fn try_into_http_request<T: Default + BufMut>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
considering_versions: &[MatrixVersion]
) -> Result<Request<T>, IntoHttpError>
Tries to convert this request into an http::Request
. Read more
Auto Trait Implementations
impl<'a> RefUnwindSafe for Request<'a>
impl<'a> Send for Request<'a>
impl<'a> Sync for Request<'a>
impl<'a> Unpin for Request<'a>
impl<'a> UnwindSafe for Request<'a>
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
sourcefn try_into_http_request_with_user_id<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
user_id: &UserId,
considering_versions: &[MatrixVersion]
) -> Result<Request<T>, IntoHttpError>where
T: Default + BufMut,
fn try_into_http_request_with_user_id<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
user_id: &UserId,
considering_versions: &[MatrixVersion]
) -> Result<Request<T>, IntoHttpError>where
T: Default + BufMut,
Tries to convert this request into an http::Request
and appends a virtual user_id
to
assert Appservice identity. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more