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