ruma_appservice_api/query/
query_room_alias.rs

1//! `GET /_matrix/app/*/rooms/{roomAlias}`
2//!
3//! Endpoint to query the existence of a given room alias.
4
5pub mod v1 {
6    //! `/v1/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/application-service-api/#get_matrixappv1roomsroomalias
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata, OwnedRoomAliasId,
13    };
14
15    const METADATA: Metadata = metadata! {
16        method: GET,
17        rate_limited: false,
18        authentication: AccessToken,
19        history: {
20            1.0 => "/_matrix/app/v1/rooms/:room_alias",
21        }
22    };
23
24    /// Request type for the `query_room_alias` endpoint.
25    #[request]
26    pub struct Request {
27        /// The room alias being queried.
28        #[ruma_api(path)]
29        pub room_alias: OwnedRoomAliasId,
30    }
31
32    /// Response type for the `query_room_alias` endpoint.
33    #[response]
34    #[derive(Default)]
35    pub struct Response {}
36
37    impl Request {
38        /// Creates a new `Request` with the given room alias.
39        pub fn new(room_alias: OwnedRoomAliasId) -> Self {
40            Self { room_alias }
41        }
42    }
43
44    impl Response {
45        /// Create an empty `Response`.
46        pub fn new() -> Self {
47            Self {}
48        }
49    }
50}