Struct ruma::api::identity_service::invitation::store_invitation::v2::Request
source · 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>,
}
api
and (crate features identity-service-api-c
or identity-service-api-s
) only.Expand description
Request type for the store_invitation
endpoint.
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.
Implementations§
source§impl Request
impl Request
sourcepub fn new(
medium: Medium,
address: String,
room_id: OwnedRoomId,
sender: OwnedUserId,
) -> 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.
sourcepub fn email(
address: String,
room_id: OwnedRoomId,
sender: OwnedUserId,
) -> Request
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§
source§impl IncomingRequest for Request
Available on crate feature server
only.
impl IncomingRequest for Request
server
only.source§type EndpointError = MatrixError
type EndpointError = MatrixError
source§type OutgoingResponse = Response
type OutgoingResponse = Response
source§impl OutgoingRequest for Request
Available on crate feature client
only.
impl OutgoingRequest for Request
client
only.source§type EndpointError = MatrixError
type EndpointError = MatrixError
source§type IncomingResponse = Response
type IncomingResponse = Response
source§fn try_into_http_request<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
considering_versions: &[MatrixVersion],
) -> Result<Request<T>, IntoHttpError>
fn try_into_http_request<T>( self, base_url: &str, access_token: SendAccessToken<'_>, considering_versions: &[MatrixVersion], ) -> Result<Request<T>, IntoHttpError>
http::Request
. Read moreAuto Trait Implementations§
impl Freeze for Request
impl RefUnwindSafe for Request
impl Send for Request
impl Sync for Request
impl Unpin for Request
impl UnwindSafe for Request
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
impl<T> OutgoingRequestAppserviceExt for Twhere
T: OutgoingRequest,
source§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>
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>
http::Request
and appends a virtual user_id
to
assert Appservice identity.