ruma_client_api/dehydrated_device/
get_dehydrated_device.rs

1//! `GET /_matrix/client/*/dehydrated_device/`
2//!
3//! Get a dehydrated device for rehydration.
4
5pub mod unstable {
6    //! `msc3814` ([MSC])
7    //!
8    //! [MSC]: https://github.com/matrix-org/matrix-spec-proposals/pull/3814
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata,
13        serde::Raw,
14        OwnedDeviceId,
15    };
16
17    use crate::dehydrated_device::DehydratedDeviceData;
18
19    const METADATA: Metadata = metadata! {
20        method: GET,
21        rate_limited: false,
22        authentication: AccessToken,
23        history: {
24            unstable => "/_matrix/client/unstable/org.matrix.msc3814.v1/dehydrated_device",
25        }
26    };
27
28    /// Request type for the `GET` `dehydrated_device` endpoint.
29    #[request(error = crate::Error)]
30    pub struct Request {}
31
32    /// Request type for the `GET` `dehydrated_device` endpoint.
33    #[response(error = crate::Error)]
34    pub struct Response {
35        /// The unique ID of the device.
36        pub device_id: OwnedDeviceId,
37        /// Information about the device.
38        pub device_data: Raw<DehydratedDeviceData>,
39    }
40
41    impl Request {
42        /// Creates a new empty `Request`.
43        pub fn new() -> Self {
44            Self {}
45        }
46    }
47
48    impl Response {
49        /// Creates a new `Response` with the given device ID and device data.
50        pub fn new(device_id: OwnedDeviceId, device_data: Raw<DehydratedDeviceData>) -> Self {
51            Self { device_id, device_data }
52        }
53    }
54}