logo
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109

//! `GET /_matrix/client/*/rooms/{roomId}/relations/{eventId}`
//!
//! Retrieve all of the child events for a given parent event.

pub mod v1 {
    //! `/v1/` ([spec])
    //!
    //! [spec]: https://spec.matrix.org/v1.3/client-server-api/#get_matrixclientv1roomsroomidrelationseventid

    use js_int::UInt;
    use ruma_common::{api::ruma_api, events::AnyMessageLikeEvent, serde::Raw, EventId, RoomId};

    ruma_api! {
        metadata: {
            description: "Get the child events for a given parent event.",
            method: GET,
            name: "get_relating_events",
            unstable_path: "/_matrix/client/unstable/rooms/:room_id/relations/:event_id",
            stable_path: "/_matrix/client/v1/rooms/:room_id/relations/:event_id",
            rate_limited: false,
            authentication: AccessToken,
            added: 1.3,
        }

        request: {
            /// The ID of the room containing the parent event.
            #[ruma_api(path)]
            pub room_id: &'a RoomId,

            /// The ID of the parent event whose child events are to be returned.
            #[ruma_api(path)]
            pub event_id: &'a EventId,

            /// The pagination token to start returning results from.
            ///
            /// If `None`, results start at the most recent topological event known to the server.
            ///
            /// Can be a `next_batch` token from a previous call, or a returned  `start` token from
            /// `/messages` or a `next_batch` token from `/sync`.
            ///
            /// Note that when paginating the `from` token should be "after" the `to` token in
            /// terms of topological ordering, because it is only possible to paginate "backwards"
            /// through events, starting at `from`.
            #[serde(skip_serializing_if = "Option::is_none")]
            #[ruma_api(query)]
            pub from: Option<&'a str>,

            /// The pagination token to stop returning results at.
            ///
            /// If `None`, results continue up to `limit` or until there are no more events.
            ///
            /// Like `from`, this can be a previous token from a prior call to this endpoint
            /// or from `/messages` or `/sync`.
            #[serde(skip_serializing_if = "Option::is_none")]
            #[ruma_api(query)]
            pub to: Option<&'a str>,

            /// The maximum number of results to return in a single `chunk`.
            ///
            /// The server can and should apply a maximum value to this parameter to avoid large
            /// responses.
            ///
            /// Similarly, the server should apply a default value when not supplied.
            #[serde(skip_serializing_if = "Option::is_none")]
            #[ruma_api(query)]
            pub limit: Option<UInt>,
        }

        response: {
            /// The paginated child events which point to the parent.
            ///
            /// The events returned are ordered topologically, most-recent first.
            ///
            /// If no events are related to the parent or the pagination yields no results, an
            /// empty `chunk` is returned.
            pub chunk: Vec<Raw<AnyMessageLikeEvent>>,

            /// An opaque string representing a pagination token.
            ///
            /// If this is `None`, there are no more results to fetch and the client should stop
            /// paginating.
            #[serde(skip_serializing_if = "Option::is_none")]
            pub next_batch: Option<String>,

            /// An opaque string representing a pagination token.
            ///
            /// If this is `None`, this is the start of the result set, i.e. this is the first
            /// batch/page.
            #[serde(skip_serializing_if = "Option::is_none")]
            pub prev_batch: Option<String>,
        }

        error: crate::Error
    }

    impl<'a> Request<'a> {
        /// Creates a new `Request` with the given room ID and parent event ID.
        pub fn new(room_id: &'a RoomId, event_id: &'a EventId) -> Self {
            Self { room_id, event_id, from: None, to: None, limit: None }
        }
    }

    impl Response {
        /// Creates a new `Response` with the given chunk.
        pub fn new(chunk: Vec<Raw<AnyMessageLikeEvent>>) -> Self {
            Self { chunk, next_batch: None, prev_batch: None }
        }
    }
}