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        api::{request, response, Metadata},
12        metadata, OwnedRoomId,
13    };
14
15    const METADATA: Metadata = metadata! {
16        method: POST,
17        rate_limited: true,
18        authentication: AccessToken,
19        history: {
20            1.0 => "/_matrix/client/r0/rooms/:room_id/forget",
21            1.1 => "/_matrix/client/v3/rooms/:room_id/forget",
22        }
23    };
24
25    /// Request type for the `forget_room` endpoint.
26    #[request(error = crate::Error)]
27    pub struct Request {
28        /// The room to forget.
29        #[ruma_api(path)]
30        pub room_id: OwnedRoomId,
31    }
32
33    /// Response type for the `forget_room` endpoint.
34    #[response(error = crate::Error)]
35    #[derive(Default)]
36    pub struct Response {}
37
38    impl Request {
39        /// Creates a new `Request` with the given room id.
40        pub fn new(room_id: OwnedRoomId) -> Self {
41            Self { room_id }
42        }
43    }
44
45    impl Response {
46        /// Creates an empty `Response`.
47        pub fn new() -> Self {
48            Self {}
49        }
50    }
51}