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
//! `PUT /_matrix/client/*/room_keys/keys/{roomId}/{sessionId}`
//!
//! Store keys in the backup for a session.
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/client-server-api/#put_matrixclientv3room_keyskeysroomidsessionid
use js_int::UInt;
use ruma_common::{
api::{request, response, Metadata},
metadata,
serde::Raw,
OwnedRoomId,
};
use crate::backup::KeyBackupData;
const METADATA: Metadata = metadata! {
method: PUT,
rate_limited: true,
authentication: AccessToken,
history: {
unstable => "/_matrix/client/unstable/room_keys/keys/:room_id/:session_id",
1.0 => "/_matrix/client/r0/room_keys/keys/:room_id/:session_id",
1.1 => "/_matrix/client/v3/room_keys/keys/:room_id/:session_id",
}
};
/// Request type for the `add_backup_keys_for_session` endpoint.
#[request(error = crate::Error)]
pub struct Request {
/// The backup version to add keys to.
///
/// Must be the current backup.
#[ruma_api(query)]
pub version: String,
/// The ID of the room to add keys to.
#[ruma_api(path)]
pub room_id: OwnedRoomId,
/// The ID of the megolm session to add keys to.
#[ruma_api(path)]
pub session_id: String,
/// The key information to store.
#[ruma_api(body)]
pub session_data: Raw<KeyBackupData>,
}
/// Response type for the `add_backup_keys_for_session` endpoint.
#[response(error = crate::Error)]
pub struct Response {
/// An opaque string representing stored keys in the backup.
///
/// Clients can compare it with the etag value they received in the request of their last
/// key storage request.
pub etag: String,
/// The number of keys stored in the backup.
pub count: UInt,
}
impl Request {
/// Creates a new `Request` with the given version, room_id, session_id and session_data.
pub fn new(
version: String,
room_id: OwnedRoomId,
session_id: String,
session_data: Raw<KeyBackupData>,
) -> Self {
Self { version, room_id, session_id, session_data }
}
}
impl Response {
/// Creates an new `Response` with the given etag and count.
pub fn new(etag: String, count: UInt) -> Self {
Self { etag, count }
}
}
}