ruma_client_api/keys/
get_keys.rs

1//! `POST /_matrix/client/*/keys/query`
2//!
3//! Returns the current devices and identity keys for the given users.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3keysquery
9
10    use std::{collections::BTreeMap, time::Duration};
11
12    use ruma_common::{
13        api::{request, response, Metadata},
14        encryption::{CrossSigningKey, DeviceKeys},
15        metadata,
16        serde::Raw,
17        OwnedDeviceId, OwnedUserId,
18    };
19    use serde_json::Value as JsonValue;
20
21    const METADATA: Metadata = metadata! {
22        method: POST,
23        rate_limited: false,
24        authentication: AccessToken,
25        history: {
26            1.0 => "/_matrix/client/r0/keys/query",
27            1.1 => "/_matrix/client/v3/keys/query",
28        }
29    };
30
31    /// Request type for the `get_keys` endpoint.
32    #[request(error = crate::Error)]
33    #[derive(Default)]
34    pub struct Request {
35        /// The time (in milliseconds) to wait when downloading keys from remote servers.
36        ///
37        /// 10 seconds is the recommended default.
38        #[serde(
39            with = "ruma_common::serde::duration::opt_ms",
40            default,
41            skip_serializing_if = "Option::is_none"
42        )]
43        pub timeout: Option<Duration>,
44
45        /// The keys to be downloaded.
46        ///
47        /// An empty list indicates all devices for the corresponding user.
48        pub device_keys: BTreeMap<OwnedUserId, Vec<OwnedDeviceId>>,
49    }
50
51    /// Response type for the `get_keys` endpoint.
52    #[response(error = crate::Error)]
53    #[derive(Default)]
54    pub struct Response {
55        /// If any remote homeservers could not be reached, they are recorded here.
56        ///
57        /// The names of the properties are the names of the unreachable servers.
58        #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
59        pub failures: BTreeMap<String, JsonValue>,
60
61        /// Information on the queried devices.
62        #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
63        pub device_keys: BTreeMap<OwnedUserId, BTreeMap<OwnedDeviceId, Raw<DeviceKeys>>>,
64
65        /// Information on the master cross-signing keys of the queried users.
66        #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
67        pub master_keys: BTreeMap<OwnedUserId, Raw<CrossSigningKey>>,
68
69        /// Information on the self-signing keys of the queried users.
70        #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
71        pub self_signing_keys: BTreeMap<OwnedUserId, Raw<CrossSigningKey>>,
72
73        /// Information on the user-signing keys of the queried users.
74        #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
75        pub user_signing_keys: BTreeMap<OwnedUserId, Raw<CrossSigningKey>>,
76    }
77
78    impl Request {
79        /// Creates an empty `Request`.
80        pub fn new() -> Self {
81            Default::default()
82        }
83    }
84
85    impl Response {
86        /// Creates an empty `Response`.
87        pub fn new() -> Self {
88            Default::default()
89        }
90    }
91}
ruma_client_api/keys/get_keys.rs

ruma_client_api/keys/
get_keys.rs
