ruma_client_api/alias/
delete_alias.rs

1//! `DELETE /_matrix/client/*/directory/room/{roomAlias}`
2//!
3//! Remove an alias from a room.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#delete_matrixclientv3directoryroomroomalias
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata, OwnedRoomAliasId,
13    };
14
15    const METADATA: Metadata = metadata! {
16        method: DELETE,
17        rate_limited: false,
18        authentication: AccessToken,
19        history: {
20            1.0 => "/_matrix/client/r0/directory/room/:room_alias",
21            1.1 => "/_matrix/client/v3/directory/room/:room_alias",
22        }
23    };
24
25    /// Request type for the `delete_alias` endpoint.
26    #[request(error = crate::Error)]
27    pub struct Request {
28        /// The room alias to remove.
29        #[ruma_api(path)]
30        pub room_alias: OwnedRoomAliasId,
31    }
32
33    /// Response type for the `delete_alias` 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 alias.
40        pub fn new(room_alias: OwnedRoomAliasId) -> Self {
41            Self { room_alias }
42        }
43    }
44
45    impl Response {
46        /// Creates an empty `Response`.
47        pub fn new() -> Self {
48            Self {}
49        }
50    }
51}