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
51
52
53
54
55
56
57
58
59
60
61

//! [GET /_matrix/client/r0/rooms/{roomId}/context/{eventId}](https://matrix.org/docs/spec/client_server/r0.4.0.html#get-matrix-client-r0-rooms-roomid-context-eventid)

use js_int::UInt;
use ruma_api::ruma_api;
use ruma_events::{collections::only, EventResult};
use ruma_identifiers::{EventId, RoomId};

use crate::r0::filter::RoomEventFilter;

ruma_api! {
    metadata {
        description: "Get the events immediately preceding and following a given event.",
        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)]
        #[serde(skip_serializing_if = "Option::is_none")]
        pub limit: Option<UInt>,
        /// The room to get events from.
        #[ruma_api(path)]
        pub room_id: RoomId,
        /// A RoomEventFilter to filter returned events with.
        #[serde(skip_serializing_if = "Option::is_none")]
        #[ruma_api(query)]
        pub filter: Option<RoomEventFilter>,
    }

    response {
        /// A token that can be used to paginate forwards with.
        pub end: String,
        /// Details of the requested event.
        #[wrap_incoming(with EventResult)]
        pub event: only::RoomEvent,
        /// A list of room events that happened just after the requested event, in chronological
        /// order.
        #[wrap_incoming(only::RoomEvent with EventResult)]
        pub events_after: Vec<only::RoomEvent>,
        /// A list of room events that happened just before the requested event, in
        /// reverse-chronological order.
        #[wrap_incoming(only::RoomEvent with EventResult)]
        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.
        #[wrap_incoming(only::StateEvent with EventResult)]
        pub state: Vec<only::StateEvent>,
    }

    error: crate::Error
}