ruma_client_api/backup/
delete_backup_keys_for_session.rs

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

ruma_client_api/backup/
delete_backup_keys_for_session.rs
