ruwuma/crates/ruma-client-api/src/r0/directory/get_room_visibility.rs
2021-10-06 10:48:08 +02:00

45 lines
1.1 KiB
Rust

//! [GET /_matrix/client/r0/directory/list/room/{roomId}](https://matrix.org/docs/spec/client_server/r0.6.1#get-matrix-client-r0-directory-list-room-roomid)
use ruma_api::ruma_api;
use ruma_identifiers::RoomId;
use crate::r0::room::Visibility;
ruma_api! {
metadata: {
description: "Get the visibility of a public room on a directory.",
name: "get_room_visibility",
method: GET,
path: "/_matrix/client/r0/directory/list/room/:room_id",
rate_limited: false,
authentication: None,
}
request: {
/// The ID of the room of which to request the visibility.
#[ruma_api(path)]
pub room_id: &'a RoomId,
}
response: {
/// Visibility of the room.
pub visibility: Visibility,
}
error: crate::Error
}
impl<'a> Request<'a> {
/// Creates a new `Request` with the given room ID.
pub fn new(room_id: &'a RoomId) -> Self {
Self { room_id }
}
}
impl Response {
/// Creates a new `Response` with the given visibility.
pub fn new(visibility: Visibility) -> Self {
Self { visibility }
}
}