ruma_client_api/keys/claim_keys/
v3.rs

1//! `/v3/` ([spec])
2//!
3//! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3keysclaim
4
5use std::{collections::BTreeMap, time::Duration};
6
7use ruma_common::{
8    api::{request, response, Metadata},
9    encryption::OneTimeKey,
10    metadata,
11    serde::Raw,
12    OneTimeKeyAlgorithm, OwnedDeviceId, OwnedOneTimeKeyId, OwnedUserId,
13};
14use serde_json::Value as JsonValue;
15
16const METADATA: Metadata = metadata! {
17    method: POST,
18    rate_limited: false,
19    authentication: AccessToken,
20    history: {
21        1.0 => "/_matrix/client/r0/keys/claim",
22        1.1 => "/_matrix/client/v3/keys/claim",
23    }
24};
25
26/// Request type for the `claim_keys` endpoint.
27#[request(error = crate::Error)]
28pub struct Request {
29    /// The time (in milliseconds) to wait when downloading keys from remote servers.
30    /// 10 seconds is the recommended default.
31    #[serde(
32        with = "ruma_common::serde::duration::opt_ms",
33        default,
34        skip_serializing_if = "Option::is_none"
35    )]
36    pub timeout: Option<Duration>,
37
38    /// The keys to be claimed.
39    pub one_time_keys: BTreeMap<OwnedUserId, BTreeMap<OwnedDeviceId, OneTimeKeyAlgorithm>>,
40}
41
42/// Response type for the `claim_keys` endpoint.
43#[response(error = crate::Error)]
44pub struct Response {
45    /// If any remote homeservers could not be reached, they are recorded here.
46    ///
47    /// The names of the properties are the names of the unreachable servers.
48    #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
49    pub failures: BTreeMap<String, JsonValue>,
50
51    /// One-time keys for the queried devices.
52    pub one_time_keys: BTreeMap<OwnedUserId, OneTimeKeys>,
53}
54
55impl Request {
56    /// Creates a new `Request` with the given key claims and the recommended 10 second timeout.
57    pub fn new(
58        one_time_keys: BTreeMap<OwnedUserId, BTreeMap<OwnedDeviceId, OneTimeKeyAlgorithm>>,
59    ) -> Self {
60        Self { timeout: Some(Duration::from_secs(10)), one_time_keys }
61    }
62}
63
64impl Response {
65    /// Creates a new `Response` with the given keys and no failures.
66    pub fn new(one_time_keys: BTreeMap<OwnedUserId, OneTimeKeys>) -> Self {
67        Self { failures: BTreeMap::new(), one_time_keys }
68    }
69}
70
71/// The one-time keys for a given device.
72pub type OneTimeKeys = BTreeMap<OwnedDeviceId, BTreeMap<OwnedOneTimeKeyId, Raw<OneTimeKey>>>;
ruma_client_api/keys/claim_keys/v3.rs

ruma_client_api/keys/claim_keys/
v3.rs
