Struct ruma::api::federation::membership::create_invite::v1::Request
source · [−]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: StateEventType,
pub state_key: &'a UserId,
pub content: RoomMemberEventContent,
pub unsigned: UnsignedEventContent,
}Available on crate feature
api and (crate features 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 RoomIdThe room ID that the user is being invited to.
event_id: &'a EventIdThe event ID for the invite event, generated by the inviting server.
sender: &'a UserIdThe matrix ID of the user who sent the original m.room.third_party_invite.
origin: &'a ServerNameThe name of the inviting homeserver.
origin_server_ts: MilliSecondsSinceUnixEpochA timestamp added by the inviting homeserver.
kind: StateEventTypeThe value m.room.member.
state_key: &'a UserIdThe user ID of the invited member.
content: RoomMemberEventContentThe content of the event.
unsigned: UnsignedEventContentInformation included alongside the event that is not signed.
Trait Implementations
sourceimpl<'a> From<RequestInit<'a>> for Request<'a>
impl<'a> From<RequestInit<'a>> for Request<'a>
sourcefn from(init: RequestInit<'a>) -> Request<'a>
fn from(init: RequestInit<'a>) -> Request<'a>
Creates a new Request from RequestInit.
sourceimpl<'a> OutgoingRequest for Request<'a>
Available on crate feature client only.
impl<'a> OutgoingRequest for Request<'a>
Available on crate feature
client only.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>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
considering_versions: &[MatrixVersion]
) -> Result<Request<T>, IntoHttpError>where
T: Default + BufMut,
fn try_into_http_request<T>(
self,
base_url: &str,
access_token: SendAccessToken<'_>,
considering_versions: &[MatrixVersion]
) -> Result<Request<T>, IntoHttpError>where
T: Default + BufMut,
Tries to convert this request into an
http::Request. Read moreAuto 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> 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