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