Struct ruma_client_api::r0::message::get_message_events::IncomingRequest

pub struct IncomingRequest {
    pub room_id: RoomId,
    pub from: String,
    pub to: Option<String>,
    pub dir: Direction,
    pub limit: UInt,
    pub filter: Option<IncomingRoomEventFilter>,
}

‘Incoming’ variant of Request.

Fields

room_id: RoomId

The room to get events from.

from: 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 API, or from a start or end token returned by a previous request to this endpoint.

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: Option<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.

impl IncomingRequest for IncomingRequest

type EndpointError = Error

A type capturing the error conditions that can be returned in the response.

type OutgoingResponse = Response

Response type to return when the request is successful.

const METADATA: Metadata

Metadata about the endpoint.

fn try_from_http_request<T: AsRef<[u8]>>(
    request: Request<T>
) -> Result<Self, FromHttpRequestError>

Tries to turn the given http::Request into this request type.