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 56 57 58 59 60 61
//! `GET /_matrix/client/*/rooms/{roomId}/state`
//!
//! Get state events for a room.
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3roomsroomidstate
use ruma_common::{
api::{request, response, Metadata},
metadata,
serde::Raw,
OwnedRoomId,
};
use ruma_events::AnyStateEvent;
const METADATA: Metadata = metadata! {
method: GET,
rate_limited: false,
authentication: AccessToken,
history: {
1.0 => "/_matrix/client/r0/rooms/:room_id/state",
1.1 => "/_matrix/client/v3/rooms/:room_id/state",
}
};
/// Request type for the `get_state_events` endpoint.
#[request(error = crate::Error)]
pub struct Request {
/// The room to look up the state for.
#[ruma_api(path)]
pub room_id: OwnedRoomId,
}
/// Response type for the `get_state_events` endpoint.
#[response(error = crate::Error)]
pub struct Response {
/// If the user is a member of the room this will be the current state of the room as a
/// list of events.
///
/// If the user has left the room then this will be the state of the room when they left as
/// a list of events.
#[ruma_api(body)]
pub room_state: Vec<Raw<AnyStateEvent>>,
}
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 room state.
pub fn new(room_state: Vec<Raw<AnyStateEvent>>) -> Self {
Self { room_state }
}
}
}