ruma_client_api/membership/
forget_room.rs

1//! `POST /_matrix/client/*/rooms/{roomId}/forget`
2//!
3//! Forget a room.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3roomsroomidforget
9
10    use ruma_common::{
11        OwnedRoomId,
12        api::{auth_scheme::AccessToken, request, response},
13        metadata,
14    };
15
16    metadata! {
17        method: POST,
18        rate_limited: true,
19        authentication: AccessToken,
20        history: {
21            1.0 => "/_matrix/client/r0/rooms/{room_id}/forget",
22            1.1 => "/_matrix/client/v3/rooms/{room_id}/forget",
23        }
24    }
25
26    /// Request type for the `forget_room` endpoint.
27    #[request(error = crate::Error)]
28    pub struct Request {
29        /// The room to forget.
30        #[ruma_api(path)]
31        pub room_id: OwnedRoomId,
32    }
33
34    /// Response type for the `forget_room` endpoint.
35    #[response(error = crate::Error)]
36    #[derive(Default)]
37    pub struct Response {}
38
39    impl Request {
40        /// Creates a new `Request` with the given room id.
41        pub fn new(room_id: OwnedRoomId) -> Self {
42            Self { room_id }
43        }
44    }
45
46    impl Response {
47        /// Creates an empty `Response`.
48        pub fn new() -> Self {
49            Self {}
50        }
51    }
52}
ruma_client_api/membership/forget_room.rs

ruma_client_api/membership/
forget_room.rs
