1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50

//! Endpoints for event context.

/// [GET /_matrix/client/r0/rooms/{roomId}/context/{eventId}](https://matrix.org/docs/spec/client_server/r0.2.0.html#get-matrix-client-r0-rooms-roomid-context-eventid)
pub mod get_context {
    use ruma_identifiers::{EventId, RoomId};
    use ruma_events::collections::only;
    use ruma_api_macros::ruma_api;

    ruma_api! {
        metadata {
            description: "Get the events immediately preceding and following a given event.",
            method: Method::Get,
            path: "/_matrix/client/r0/rooms/:room_id/context/:event_id",
            name: "get_context",
            rate_limited: false,
            requires_authentication: true,
        }

        request {
            /// The event to get context around.
            #[ruma_api(path)]
            pub event_id: EventId,
            /// The maximum number of events to return.
            ///
            /// Defaults to 10 if not supplied.
            #[ruma_api(query)]
            pub limit: u8,
            /// The room to get events from.
            #[ruma_api(path)]
            pub room_id: RoomId,
        }

        response {
            /// A token that can be used to paginate forwards with.
            pub end: String,
            /// Details of the requested event.
            pub event: only::RoomEvent,
            /// A list of room events that happened just after the requested event, in chronological
            /// order.
            pub events_after: Vec<only::RoomEvent>,
            /// A list of room events that happened just before the requested event, in
            /// reverse-chronological order.
            pub events_before: Vec<only::RoomEvent>,
            /// A token that can be used to paginate backwards with.
            pub start: String,
            /// The state of the room at the last event returned.
            pub state: Vec<only::StateEvent>,
        }
    }
}