ruma_client_api/backup/
delete_backup_keys_for_room.rs

Help
1//! `DELETE /_matrix/client/*/room_keys/keys/{roomId}`
2//!
3//! Delete keys from a backup for a given room.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#delete_matrixclientv3room_keyskeysroomid
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",
22            1.0 => "/_matrix/client/r0/room_keys/keys/:room_id",
23            1.1 => "/_matrix/client/v3/room_keys/keys/:room_id",
24        }
25    };
26
27    /// Request type for the `delete_backup_keys_for_room` 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
39    /// Response type for the `delete_backup_keys_for_room` endpoint.
40    #[response(error = crate::Error)]
41    pub struct Response {
42        /// An opaque string representing stored keys in the backup.
43        ///
44        /// Clients can compare it with the etag value they received in the request of their last
45        /// key storage request.
46        pub etag: String,
47
48        /// The number of keys stored in the backup.
49        pub count: UInt,
50    }
51
52    impl Request {
53        /// Creates a new `Request` with the given version and room_id.
54        pub fn new(version: String, room_id: OwnedRoomId) -> Self {
55            Self { version, room_id }
56        }
57    }
58
59    impl Response {
60        /// Creates an new `Response` with the given etag and count.
61        pub fn new(etag: String, count: UInt) -> Self {
62            Self { etag, count }
63        }
64    }
65}
ruma_client_api/backup/delete_backup_keys_for_room.rs

ruma_client_api/backup/
delete_backup_keys_for_room.rs
