ruma_client_api/backup/
get_backup_keys_for_session.rs

1//! `GET /_matrix/client/*/room_keys/keys/{roomId}/{sessionId}`
2//!
3//! Retrieve a key from the backup for a given session.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3room_keyskeysroomidsessionid
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata,
13        serde::Raw,
14        OwnedRoomId,
15    };
16
17    use crate::backup::KeyBackupData;
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/:room_id/:session_id",
25            1.0 => "/_matrix/client/r0/room_keys/keys/:room_id/:session_id",
26            1.1 => "/_matrix/client/v3/room_keys/keys/:room_id/:session_id",
27        }
28    };
29
30    /// Request type for the `get_backup_keys_for_session` 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        /// The ID of the room that the requested key is for.
38        #[ruma_api(path)]
39        pub room_id: OwnedRoomId,
40
41        /// The ID of the megolm session whose key is requested.
42        #[ruma_api(path)]
43        pub session_id: String,
44    }
45
46    /// Response type for the `get_backup_keys_for_session` endpoint.
47    #[response(error = crate::Error)]
48    pub struct Response {
49        /// Information about the requested backup key.
50        #[ruma_api(body)]
51        pub key_data: Raw<KeyBackupData>,
52    }
53
54    impl Request {
55        /// Creates a new `Request` with the given version, room_id and session_id.
56        pub fn new(version: String, room_id: OwnedRoomId, session_id: String) -> Self {
57            Self { version, room_id, session_id }
58        }
59    }
60
61    impl Response {
62        /// Creates a new `Response` with the given key_data.
63        pub fn new(key_data: Raw<KeyBackupData>) -> Self {
64            Self { key_data }
65        }
66    }
67}