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
//! `GET /_matrix/client/*/directory/list/room/{roomId}`
//!
//! Get the visibility of a public room on a directory.
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3directorylistroomroomid
use ruma_common::{
api::{request, response, Metadata},
metadata, OwnedRoomId,
};
use crate::room::Visibility;
const METADATA: Metadata = metadata! {
method: GET,
rate_limited: false,
authentication: None,
history: {
1.0 => "/_matrix/client/r0/directory/list/room/:room_id",
1.1 => "/_matrix/client/v3/directory/list/room/:room_id",
}
};
/// Request type for the `get_room_visibility` endpoint.
#[request(error = crate::Error)]
pub struct Request {
/// The ID of the room of which to request the visibility.
#[ruma_api(path)]
pub room_id: OwnedRoomId,
}
/// Response type for the `get_room_visibility` endpoint.
#[response(error = crate::Error)]
pub struct Response {
/// Visibility of the room.
pub visibility: Visibility,
}
impl Request {
/// Creates a new `Request` with the given room ID.
pub fn new(room_id: OwnedRoomId) -> Self {
Self { room_id }
}
}
impl Response {
/// Creates a new `Response` with the given visibility.
pub fn new(visibility: Visibility) -> Self {
Self { visibility }
}
}
}