Struct matrix_sdk_base::ruma::api::client::message::get_message_events::v3::Request
source · #[non_exhaustive]pub struct Request {
pub room_id: OwnedRoomId,
pub from: Option<String>,
pub to: Option<String>,
pub dir: Direction,
pub limit: UInt,
pub filter: RoomEventFilter,
}
api
and (crate features client
or server
) only.Expand description
Request type for the get_message_events
endpoint.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.room_id: OwnedRoomId
The room to get events from.
from: Option<String>
The token to start returning events from.
This token can be obtained from a prev_batch
token returned for each room by the
sync endpoint, or from a start
or end
token returned by a previous request to
this endpoint.
If this is None
, the server will return messages from the start or end of the
history visible to the user, depending on the value of dir
.
to: Option<String>
The token to stop returning events at.
This token can be obtained from a prev_batch
token returned for each room by the
sync endpoint, or from a start
or end
token returned by a previous request to
this endpoint.
dir: Direction
The direction to return events from.
limit: UInt
The maximum number of events to return.
Default: 10
.
filter: RoomEventFilter
A RoomEventFilter
to filter returned events with.
Implementations§
source§impl Request
impl Request
sourcepub fn new(room_id: OwnedRoomId, dir: Direction) -> Request
pub fn new(room_id: OwnedRoomId, dir: Direction) -> Request
Creates a new Request
with the given room ID and direction.
All other parameters will be defaulted.
sourcepub fn backward(room_id: OwnedRoomId) -> Request
pub fn backward(room_id: OwnedRoomId) -> Request
Creates a new Request
with the given room ID and dir
set to Backward
.
If the returned request is sent without from
being set, pagination will start at the
end of (the accessible part of) the room timeline.
§Example
let request = get_message_events::v3::Request::backward(room_id).from(token);
sourcepub fn forward(room_id: OwnedRoomId) -> Request
pub fn forward(room_id: OwnedRoomId) -> Request
Creates a new Request
with the given room ID and dir
set to Forward
.
If the returned request is sent without from
being set, pagination will start at the
beginning of (the accessible part of) the room timeline.
§Example
let request = get_message_events::v3::Request::forward(room_id).from(token);
Trait Implementations§
source§impl OutgoingRequest for Request
Available on crate feature client
only.
impl OutgoingRequest for Request
client
only.§type EndpointError = Error
type EndpointError = Error
§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§default unsafe fn clone_to_uninit(&self, dst: *mut T)
default unsafe fn clone_to_uninit(&self, dst: *mut T)
clone_to_uninit
)§impl<T> CompatExt for T
impl<T> CompatExt for T
source§impl<T, UT> HandleAlloc<UT> for T
impl<T, UT> HandleAlloc<UT> for T
source§fn consume_handle(handle: Handle) -> Arc<T>
fn consume_handle(handle: Handle) -> Arc<T>
Arc<>
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,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§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.