ruma_client_api/room/
get_event_by_timestamp.rs

Help
1//! `GET /_matrix/client/*/rooms/{roomId}/timestamp_to_event`
2//!
3//! Get the ID of the event closest to the given timestamp.
4
5pub mod v1 {
6    //! `/v1/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv1roomsroomidtimestamp_to_event
9
10    use ruma_common::{
11        api::{request, response, Direction, Metadata},
12        metadata, MilliSecondsSinceUnixEpoch, OwnedEventId, OwnedRoomId,
13    };
14
15    const METADATA: Metadata = metadata! {
16        method: GET,
17        rate_limited: true,
18        authentication: AccessToken,
19        history: {
20            unstable => "/_matrix/client/unstable/org.matrix.msc3030/rooms/:room_id/timestamp_to_event",
21            1.6 => "/_matrix/client/v1/rooms/:room_id/timestamp_to_event",
22        }
23    };
24
25    /// Request type for the `get_event_by_timestamp` endpoint.
26    #[request(error = crate::Error)]
27    pub struct Request {
28        /// The ID of the room the event is in.
29        #[ruma_api(path)]
30        pub room_id: OwnedRoomId,
31
32        /// The timestamp to search from, inclusively.
33        #[ruma_api(query)]
34        pub ts: MilliSecondsSinceUnixEpoch,
35
36        /// The direction in which to search.
37        #[ruma_api(query)]
38        pub dir: Direction,
39    }
40
41    /// Response type for the `get_event_by_timestamp` endpoint.
42    #[response(error = crate::Error)]
43    pub struct Response {
44        /// The ID of the event found.
45        pub event_id: OwnedEventId,
46
47        /// The event's timestamp.
48        pub origin_server_ts: MilliSecondsSinceUnixEpoch,
49    }
50
51    impl Request {
52        /// Creates a new `Request` with the given room ID, timestamp and direction.
53        pub fn new(room_id: OwnedRoomId, ts: MilliSecondsSinceUnixEpoch, dir: Direction) -> Self {
54            Self { room_id, ts, dir }
55        }
56
57        /// Creates a new `Request` with the given room ID and timestamp, and the direction set to
58        /// `Backward`.
59        ///
60        /// Allows to have the latest event before or including the given timestamp.
61        pub fn until(room_id: OwnedRoomId, ts: MilliSecondsSinceUnixEpoch) -> Self {
62            Self::new(room_id, ts, Direction::Backward)
63        }
64
65        /// Creates a new `Request` with the given room ID and timestamp, and the direction set to
66        /// `Forward`.
67        ///
68        /// Allows to have the earliest event including or after the given timestamp.
69        pub fn since(room_id: OwnedRoomId, ts: MilliSecondsSinceUnixEpoch) -> Self {
70            Self::new(room_id, ts, Direction::Forward)
71        }
72    }
73
74    impl Response {
75        /// Creates a new `Response` with the given event ID and timestamp.
76        pub fn new(event_id: OwnedEventId, origin_server_ts: MilliSecondsSinceUnixEpoch) -> Self {
77            Self { event_id, origin_server_ts }
78        }
79    }
80}
ruma_client_api/room/get_event_by_timestamp.rs

ruma_client_api/room/
get_event_by_timestamp.rs
