Struct ruma::api::federation::membership::create_invite::v1::Request [−][src]
pub struct Request<'a> { pub room_id: &'a RoomId, pub event_id: &'a EventId, pub sender: &'a UserId, pub origin: &'a ServerName, pub origin_server_ts: MilliSecondsSinceUnixEpoch, pub kind: EventType, pub state_key: &'a UserId, pub content: MemberEventContent, pub unsigned: UnsignedEventContent, }
api
and (crate features federation-api
or federation-api-c
or federation-api-s
) only.Expand description
Data for a request to the create_invite
API endpoint.
Invites a remote user to a room.
Fields
room_id: &'a RoomId
The room ID that the user is being invited to.
event_id: &'a EventId
The event ID for the invite event, generated by the inviting server.
sender: &'a UserId
The matrix ID of the user who sent the original m.room.third_party_invite
.
origin: &'a ServerName
The name of the inviting homeserver.
origin_server_ts: MilliSecondsSinceUnixEpoch
A timestamp added by the inviting homeserver.
kind: EventType
The value m.room.member
.
state_key: &'a UserId
The user ID of the invited member.
content: MemberEventContent
The content of the event.
unsigned: UnsignedEventContent
Information included alongside the event that is not signed.
Trait Implementations
Creates a new Request
from RequestInit
.
type Incoming = IncomingRequest
type Incoming = IncomingRequest
The ‘Incoming’ variant of Self
.
type EndpointError = MatrixError
type EndpointError = MatrixError
A type capturing the expected error conditions the server can return.
type IncomingResponse = <Response as Outgoing>::Incoming
type IncomingResponse = <Response as Outgoing>::Incoming
Response type returned when the request is successful.
pub fn try_into_http_request<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>
) -> Result<Request<T>, IntoHttpError> where
T: Default + BufMut,
pub fn try_into_http_request<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>
) -> Result<Request<T>, IntoHttpError> where
T: Default + BufMut,
Tries to convert this request into an http::Request
. Read more
Auto Trait Implementations
impl<'a> RefUnwindSafe for Request<'a>
impl<'a> UnwindSafe for Request<'a>
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
fn try_into_http_request_with_user_id<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
user_id: UserId
) -> 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
) -> 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
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