ruma_client_api/keys/
get_key_changes.rs

Help
1//! `GET /_matrix/client/*/keys/changes`
2//!
3//! Gets a list of users who have updated their device identity keys since a previous sync token.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3keyschanges
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata, OwnedUserId,
13    };
14
15    const METADATA: Metadata = metadata! {
16        method: GET,
17        rate_limited: false,
18        authentication: AccessToken,
19        history: {
20            1.0 => "/_matrix/client/r0/keys/changes",
21            1.1 => "/_matrix/client/v3/keys/changes",
22        }
23    };
24
25    /// Request type for the `get_key_changes` endpoint.
26    #[request(error = crate::Error)]
27    pub struct Request {
28        /// The desired start point of the list.
29        ///
30        /// Should be the next_batch field from a response to an earlier call to /sync.
31        #[ruma_api(query)]
32        pub from: String,
33
34        /// The desired end point of the list.
35        ///
36        /// Should be the next_batch field from a recent call to /sync - typically the most recent
37        /// such call.
38        #[ruma_api(query)]
39        pub to: String,
40    }
41
42    /// Response type for the `get_key_changes` endpoint.
43    #[response(error = crate::Error)]
44    pub struct Response {
45        /// The Matrix User IDs of all users who updated their device identity keys.
46        pub changed: Vec<OwnedUserId>,
47
48        /// The Matrix User IDs of all users who may have left all the end-to-end
49        /// encrypted rooms they previously shared with the user.
50        pub left: Vec<OwnedUserId>,
51    }
52
53    impl Request {
54        /// Creates a new `Request` with the given start and end points.
55        pub fn new(from: String, to: String) -> Self {
56            Self { from, to }
57        }
58    }
59
60    impl Response {
61        /// Creates a new `Response` with the given changed and left user ID lists.
62        pub fn new(changed: Vec<OwnedUserId>, left: Vec<OwnedUserId>) -> Self {
63            Self { changed, left }
64        }
65    }
66}
ruma_client_api/keys/get_key_changes.rs

ruma_client_api/keys/
get_key_changes.rs
