Struct ruma_client_api::message::get_message_events::v3::IncomingRequest

#[non_exhaustive]
pub struct IncomingRequest {
    pub room_id: OwnedRoomId,
    pub from: Option<String>,
    pub to: Option<String>,
    pub dir: Direction,
    pub limit: UInt,
    pub filter: IncomingRoomEventFilter,
}

‘Incoming’ variant of Request.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional 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.

Note: This field is marked required in v1.2 of the specification, but that is changing, most likely as part of v1.3. To frontload the breaking change, this field is optional already even though v1.2 is the latest version at the time of writing. The specification change can be found here.

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: IncomingRoomEventFilter

A RoomEventFilter to filter returned events with.

Trait Implementations

impl Debug for IncomingRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.