Struct ruma::api::federation::membership::create_join_event::v2::Request
source · pub struct Request {
pub room_id: OwnedRoomId,
pub event_id: OwnedEventId,
pub pdu: Box<RawValue>,
pub omit_members: bool,
}
api
and (crate features federation-api-c
or federation-api-s
) only.Expand description
Request type for the create_join_event
endpoint.
Fields§
§room_id: OwnedRoomId
The room ID that is about to be joined.
Do not use this. Instead, use the room_id
field inside the PDU.
event_id: OwnedEventId
The event ID for the join event.
pdu: Box<RawValue>
The PDU.
omit_members: bool
Indicates whether the calling server can accept a reduced response.
If true
, membership events are omitted from state
and redundant events are omitted from
auth_chain
in the response.
If the room to be joined has no m.room.name
nor m.room.canonical_alias
events in its
current state, the resident server should determine the room members who would be
included in the m.heroes
property of the room summary as defined in the Client-Server
/sync
response. The resident server should include these members’ membership events in
the response state
field, and include the auth chains for these membership events in
the response auth_chain
field.
Implementations§
source§impl Request
impl Request
sourcepub fn new(
room_id: OwnedRoomId,
event_id: OwnedEventId,
pdu: Box<RawValue>,
) -> Request
pub fn new( room_id: OwnedRoomId, event_id: OwnedEventId, pdu: Box<RawValue>, ) -> Request
Creates a new Request
from the given room ID, event ID and PDU.
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.