ruma_client_api/alias/
get_alias.rs

Help
1//! `GET /_matrix/client/*/directory/room/{roomAlias}`
2//!
3//! Resolve a room alias to a room ID.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3directoryroomroomalias
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata, OwnedRoomAliasId, OwnedRoomId, OwnedServerName,
13    };
14
15    const METADATA: Metadata = metadata! {
16        method: GET,
17        rate_limited: false,
18        authentication: None,
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 `get_alias` endpoint.
26    #[request(error = crate::Error)]
27    pub struct Request {
28        /// The room alias.
29        #[ruma_api(path)]
30        pub room_alias: OwnedRoomAliasId,
31    }
32
33    /// Response type for the `get_alias` endpoint.
34    #[response(error = crate::Error)]
35    pub struct Response {
36        /// The room ID for this room alias.
37        pub room_id: OwnedRoomId,
38
39        /// A list of servers that are aware of this room ID.
40        pub servers: Vec<OwnedServerName>,
41    }
42
43    impl Request {
44        /// Creates a new `Request` with the given room alias id.
45        pub fn new(room_alias: OwnedRoomAliasId) -> Self {
46            Self { room_alias }
47        }
48    }
49
50    impl Response {
51        /// Creates a new `Response` with the given room id and servers
52        pub fn new(room_id: OwnedRoomId, servers: Vec<OwnedServerName>) -> Self {
53            Self { room_id, servers }
54        }
55    }
56}
ruma_client_api/alias/get_alias.rs

ruma_client_api/alias/
get_alias.rs
