ruma_client_api/backup/
get_backup_keys_for_room.rs

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