ruma_client_api/backup/
add_backup_keys_for_room.rs

Help
1//! `PUT /_matrix/client/*/room_keys/keys/{roomId}`
2//!
3//! Store keys in the backup for a room.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#put_matrixclientv3room_keyskeysroomid
9
10    use std::collections::BTreeMap;
11
12    use js_int::UInt;
13    use ruma_common::{
14        api::{request, response, Metadata},
15        metadata,
16        serde::Raw,
17        OwnedRoomId,
18    };
19
20    use crate::backup::KeyBackupData;
21
22    const METADATA: Metadata = metadata! {
23        method: PUT,
24        rate_limited: true,
25        authentication: AccessToken,
26        history: {
27            unstable => "/_matrix/client/unstable/room_keys/keys/:room_id",
28            1.0 => "/_matrix/client/r0/room_keys/keys/:room_id",
29            1.1 => "/_matrix/client/v3/room_keys/keys/:room_id",
30        }
31    };
32
33    /// Request type for the `add_backup_keys_for_room` endpoint.
34    #[request(error = crate::Error)]
35    pub struct Request {
36        /// The backup version to add keys to.
37        ///
38        /// Must be the current backup.
39        #[ruma_api(query)]
40        pub version: String,
41
42        /// The ID of the room to add keys to.
43        #[ruma_api(path)]
44        pub room_id: OwnedRoomId,
45
46        /// A map of session IDs to key data to store.
47        pub sessions: BTreeMap<String, Raw<KeyBackupData>>,
48    }
49
50    /// Response type for the `add_backup_keys_for_room` endpoint.
51    #[response(error = crate::Error)]
52    pub struct Response {
53        /// An opaque string representing stored keys in the backup.
54        ///
55        /// Clients can compare it with the etag value they received in the request of their last
56        /// key storage request.
57        pub etag: String,
58
59        /// The number of keys stored in the backup.
60        pub count: UInt,
61    }
62
63    impl Request {
64        /// Creates a new `Request` with the given version, room_id and sessions.
65        pub fn new(
66            version: String,
67            room_id: OwnedRoomId,
68            sessions: BTreeMap<String, Raw<KeyBackupData>>,
69        ) -> Self {
70            Self { version, room_id, sessions }
71        }
72    }
73
74    impl Response {
75        /// Creates an new `Response` with the given etag and count.
76        pub fn new(etag: String, count: UInt) -> Self {
77            Self { etag, count }
78        }
79    }
80}
ruma_client_api/backup/add_backup_keys_for_room.rs

ruma_client_api/backup/
add_backup_keys_for_room.rs
