ruma-client-api 0.11.0

Types for the endpoints in the Matrix client-server API.
Documentation 
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

//! [GET /_matrix/client/r0/directory/list/room/{roomId}](https://matrix.org/docs/spec/client_server/r0.6.0#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 }
    }
}