ruma_client_api/backup/
get_backup_keys.rs

Help
1//! `GET /_matrix/client/*/room_keys/keys`
2//!
3//! Retrieve all keys from a backup version.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3room_keyskeys
9
10    use std::collections::BTreeMap;
11
12    use ruma_common::{
13        api::{request, response, Metadata},
14        metadata, OwnedRoomId,
15    };
16
17    use crate::backup::RoomKeyBackup;
18
19    const METADATA: Metadata = metadata! {
20        method: GET,
21        rate_limited: true,
22        authentication: AccessToken,
23        history: {
24            unstable => "/_matrix/client/unstable/room_keys/keys",
25            1.0 => "/_matrix/client/r0/room_keys/keys",
26            1.1 => "/_matrix/client/v3/room_keys/keys",
27        }
28    };
29
30    /// Request type for the `get_backup_keys` endpoint.
31    #[request(error = crate::Error)]
32    pub struct Request {
33        /// The backup version to retrieve keys from.
34        #[ruma_api(query)]
35        pub version: String,
36    }
37
38    /// Response type for the `get_backup_keys` endpoint.
39    #[response(error = crate::Error)]
40    pub struct Response {
41        /// A map from room IDs to session IDs to key data.
42        pub rooms: BTreeMap<OwnedRoomId, RoomKeyBackup>,
43    }
44
45    impl Request {
46        /// Creates a new `Request` with the given version.
47        pub fn new(version: String) -> Self {
48            Self { version }
49        }
50    }
51
52    impl Response {
53        /// Creates a new `Response` with the given room key backups.
54        pub fn new(rooms: BTreeMap<OwnedRoomId, RoomKeyBackup>) -> Self {
55            Self { rooms }
56        }
57    }
58}
ruma_client_api/backup/get_backup_keys.rs

ruma_client_api/backup/
get_backup_keys.rs
