ruma_client_api/dehydrated_device/
put_dehydrated_device.rs

Help
1//! `PUT /_matrix/client/*/dehydrated_device/`
2//!
3//! Uploads a dehydrated device to the homeserver.
4
5pub mod unstable {
6    //! `msc3814` ([MSC])
7    //!
8    //! [MSC]: https://github.com/matrix-org/matrix-spec-proposals/pull/3814
9
10    use std::collections::BTreeMap;
11
12    use ruma_common::{
13        api::{request, response, Metadata},
14        encryption::{DeviceKeys, OneTimeKey},
15        metadata,
16        serde::Raw,
17        OwnedDeviceId, OwnedOneTimeKeyId,
18    };
19
20    use crate::dehydrated_device::DehydratedDeviceData;
21
22    const METADATA: Metadata = metadata! {
23        method: PUT,
24        rate_limited: false,
25        authentication: AccessToken,
26        history: {
27            unstable => "/_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device",
28        }
29    };
30
31    /// Request type for the `PUT` `dehydrated_device` endpoint.
32    #[request(error = crate::Error)]
33    pub struct Request {
34        /// The unique ID of the device.
35        pub device_id: OwnedDeviceId,
36
37        /// The display name of the device.
38        pub initial_device_display_name: Option<String>,
39
40        /// The data of the dehydrated device, containing the serialized and encrypted private
41        /// parts of the [`DeviceKeys`].
42        pub device_data: Raw<DehydratedDeviceData>,
43
44        /// Identity keys for the dehydrated device.
45        pub device_keys: Raw<DeviceKeys>,
46
47        /// One-time public keys for "pre-key" messages.
48        #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
49        pub one_time_keys: BTreeMap<OwnedOneTimeKeyId, Raw<OneTimeKey>>,
50
51        /// Fallback public keys for "pre-key" messages.
52        #[serde(default, skip_serializing_if = "BTreeMap::is_empty")]
53        pub fallback_keys: BTreeMap<OwnedOneTimeKeyId, Raw<OneTimeKey>>,
54    }
55
56    /// Response type for the `upload_keys` endpoint.
57    #[response(error = crate::Error)]
58    pub struct Response {
59        /// The unique ID of the device.
60        pub device_id: OwnedDeviceId,
61    }
62
63    impl Request {
64        /// Creates a new Request.
65        pub fn new(
66            device_id: OwnedDeviceId,
67            device_data: Raw<DehydratedDeviceData>,
68            device_keys: Raw<DeviceKeys>,
69        ) -> Self {
70            Self {
71                device_id,
72                device_data,
73                device_keys,
74                initial_device_display_name: None,
75                one_time_keys: Default::default(),
76                fallback_keys: Default::default(),
77            }
78        }
79    }
80
81    impl Response {
82        /// Creates a new `Response` with the given one time key counts.
83        pub fn new(device_id: OwnedDeviceId) -> Self {
84            Self { device_id }
85        }
86    }
87}
ruma_client_api/dehydrated_device/put_dehydrated_device.rs

ruma_client_api/dehydrated_device/
put_dehydrated_device.rs
