ruma_client_api/state/
get_state_events.rs

Help
1//! `GET /_matrix/client/*/rooms/{roomId}/state`
2//!
3//! Get state events for a room.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3roomsroomidstate
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata,
13        serde::Raw,
14        OwnedRoomId,
15    };
16    use ruma_events::AnyStateEvent;
17
18    const METADATA: Metadata = metadata! {
19        method: GET,
20        rate_limited: false,
21        authentication: AccessToken,
22        history: {
23            1.0 => "/_matrix/client/r0/rooms/:room_id/state",
24            1.1 => "/_matrix/client/v3/rooms/:room_id/state",
25        }
26    };
27
28    /// Request type for the `get_state_events` endpoint.
29    #[request(error = crate::Error)]
30    pub struct Request {
31        /// The room to look up the state for.
32        #[ruma_api(path)]
33        pub room_id: OwnedRoomId,
34    }
35
36    /// Response type for the `get_state_events` endpoint.
37    #[response(error = crate::Error)]
38    pub struct Response {
39        /// If the user is a member of the room this will be the current state of the room as a
40        /// list of events.
41        ///
42        /// If the user has left the room then this will be the state of the room when they left as
43        /// a list of events.
44        #[ruma_api(body)]
45        pub room_state: Vec<Raw<AnyStateEvent>>,
46    }
47
48    impl Request {
49        /// Creates a new `Request` with the given room ID.
50        pub fn new(room_id: OwnedRoomId) -> Self {
51            Self { room_id }
52        }
53    }
54
55    impl Response {
56        /// Creates a new `Response` with the given room state.
57        pub fn new(room_state: Vec<Raw<AnyStateEvent>>) -> Self {
58            Self { room_state }
59        }
60    }
61}
ruma_client_api/state/get_state_events.rs

ruma_client_api/state/
get_state_events.rs
