ruma_client_api/context/
get_context.rs

1//! `GET /_matrix/client/*/rooms/{roomId}/context/{eventId}`
2//!
3//! Get the events immediately preceding and following a given event.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3roomsroomidcontexteventid
9
10    use js_int::{uint, UInt};
11    use ruma_common::{
12        api::{request, response, Metadata},
13        metadata,
14        serde::Raw,
15        OwnedEventId, OwnedRoomId,
16    };
17    use ruma_events::{AnyStateEvent, AnyTimelineEvent};
18
19    use crate::filter::RoomEventFilter;
20
21    const METADATA: Metadata = metadata! {
22        method: GET,
23        rate_limited: false,
24        authentication: AccessToken,
25        history: {
26            1.0 => "/_matrix/client/r0/rooms/:room_id/context/:event_id",
27            1.1 => "/_matrix/client/v3/rooms/:room_id/context/:event_id",
28        }
29    };
30
31    /// Request type for the `get_context` endpoint.
32    #[request(error = crate::Error)]
33    pub struct Request {
34        /// The room to get events from.
35        #[ruma_api(path)]
36        pub room_id: OwnedRoomId,
37
38        /// The event to get context around.
39        #[ruma_api(path)]
40        pub event_id: OwnedEventId,
41
42        /// The maximum number of context events to return.
43        ///
44        /// This limit applies to the sum of the `events_before` and `events_after` arrays. The
45        /// requested event ID is always returned in `event` even if the limit is `0`.
46        ///
47        /// Defaults to 10.
48        #[ruma_api(query)]
49        #[serde(default = "default_limit", skip_serializing_if = "is_default_limit")]
50        pub limit: UInt,
51
52        /// A RoomEventFilter to filter returned events with.
53        #[ruma_api(query)]
54        #[serde(
55            with = "ruma_common::serde::json_string",
56            default,
57            skip_serializing_if = "RoomEventFilter::is_empty"
58        )]
59        pub filter: RoomEventFilter,
60    }
61
62    /// Response type for the `get_context` endpoint.
63    #[response(error = crate::Error)]
64    #[derive(Default)]
65    pub struct Response {
66        /// A token that can be used to paginate backwards with.
67        #[serde(skip_serializing_if = "Option::is_none")]
68        pub start: Option<String>,
69
70        /// A token that can be used to paginate forwards with.
71        #[serde(skip_serializing_if = "Option::is_none")]
72        pub end: Option<String>,
73
74        /// A list of room events that happened just before the requested event,
75        /// in reverse-chronological order.
76        #[serde(default, skip_serializing_if = "Vec::is_empty")]
77        pub events_before: Vec<Raw<AnyTimelineEvent>>,
78
79        /// Details of the requested event.
80        #[serde(skip_serializing_if = "Option::is_none")]
81        pub event: Option<Raw<AnyTimelineEvent>>,
82
83        /// A list of room events that happened just after the requested event,
84        /// in chronological order.
85        #[serde(default, skip_serializing_if = "Vec::is_empty")]
86        pub events_after: Vec<Raw<AnyTimelineEvent>>,
87
88        /// The state of the room at the last event returned.
89        #[serde(default, skip_serializing_if = "Vec::is_empty")]
90        pub state: Vec<Raw<AnyStateEvent>>,
91    }
92
93    impl Request {
94        /// Creates a new `Request` with the given room id and event id.
95        pub fn new(room_id: OwnedRoomId, event_id: OwnedEventId) -> Self {
96            Self { room_id, event_id, limit: default_limit(), filter: RoomEventFilter::default() }
97        }
98    }
99
100    impl Response {
101        /// Creates an empty `Response`.
102        pub fn new() -> Self {
103            Default::default()
104        }
105    }
106
107    fn default_limit() -> UInt {
108        uint!(10)
109    }
110
111    #[allow(clippy::trivially_copy_pass_by_ref)]
112    fn is_default_limit(val: &UInt) -> bool {
113        *val == default_limit()
114    }
115}
ruma_client_api/context/get_context.rs

ruma_client_api/context/
get_context.rs
