Struct ruma::api::federation::membership::create_invite::v2::Request
source · [−]pub struct Request<'a> {
pub room_id: &'a RoomId,
pub event_id: &'a EventId,
pub room_version: &'a RoomVersionId,
pub event: &'a RawValue,
pub invite_room_state: &'a [Raw<AnyStrippedStateEvent>],
}
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 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.
room_version: &'a RoomVersionId
The version of the room where the user is being invited to.
event: &'a RawValue
The invite event which needs to be signed.
invite_room_state: &'a [Raw<AnyStrippedStateEvent>]
An optional list of simplified events to help the receiver of the invite identify the room.
Implementations
sourceimpl<'a> Request<'a>
impl<'a> Request<'a>
sourcepub fn new(
room_id: &'a RoomId,
event_id: &'a EventId,
room_version: &'a RoomVersionId,
event: &'a RawValue,
invite_room_state: &'a [Raw<AnyStrippedStateEvent>]
) -> Request<'a>
pub fn new(
room_id: &'a RoomId,
event_id: &'a EventId,
room_version: &'a RoomVersionId,
event: &'a RawValue,
invite_room_state: &'a [Raw<AnyStrippedStateEvent>]
) -> Request<'a>
Creates a new Request
with the given room ID, event ID, room version, event and invite
room state.
Trait Implementations
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