ruma_client_api/membership/
joined_rooms.rs

1//! `GET /_matrix/client/*/joined_rooms`
2//!
3//! Get a list of the user's current rooms.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3joined_rooms
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata, OwnedRoomId,
13    };
14
15    const METADATA: Metadata = metadata! {
16        method: GET,
17        rate_limited: false,
18        authentication: AccessToken,
19        history: {
20            1.0 => "/_matrix/client/r0/joined_rooms",
21            1.1 => "/_matrix/client/v3/joined_rooms",
22        }
23    };
24
25    /// Request type for the `joined_rooms` endpoint.
26    #[request(error = crate::Error)]
27    #[derive(Default)]
28    pub struct Request {}
29
30    /// Response type for the `joined_rooms` endpoint.
31    #[response(error = crate::Error)]
32    pub struct Response {
33        /// A list of the rooms the user is in, i.e. the ID of each room in
34        /// which the user has joined membership.
35        pub joined_rooms: Vec<OwnedRoomId>,
36    }
37
38    impl Request {
39        /// Creates an empty `Request`.
40        pub fn new() -> Self {
41            Self {}
42        }
43    }
44
45    impl Response {
46        /// Creates a new `Response` with the given joined rooms.
47        pub fn new(joined_rooms: Vec<OwnedRoomId>) -> Self {
48            Self { joined_rooms }
49        }
50    }
51}