ruma_client_api/peeking/
get_current_state.rs

Help
1//! `GET /_matrix/client/*/rooms/{roomId}/initialSync`
2//!
3//! Get a copy of the current state and the most recent messages in a room.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3roomsroomidinitialsync
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata,
13        serde::Raw,
14        OwnedRoomId,
15    };
16    use ruma_events::{
17        room::member::MembershipState, AnyRoomAccountDataEvent, AnyStateEvent, AnyTimelineEvent,
18    };
19    use serde::{Deserialize, Serialize};
20
21    use crate::room::Visibility;
22
23    const METADATA: Metadata = metadata! {
24        method: GET,
25        rate_limited: false,
26        authentication: AccessToken,
27        history: {
28            1.0 => "/_matrix/client/r0/rooms/:room_id/initialSync",
29            1.1 => "/_matrix/client/v3/rooms/:room_id/initialSync",
30        }
31    };
32
33    /// Request type for the `get_current_state` endpoint.
34    #[request(error = crate::Error)]
35    pub struct Request {
36        /// The room to get the data of.
37        #[ruma_api(path)]
38        pub room_id: OwnedRoomId,
39    }
40
41    impl Request {
42        /// Creates a `Request` for the given room.
43        pub fn new(room_id: OwnedRoomId) -> Self {
44            Self { room_id }
45        }
46    }
47
48    /// Response type for the `get_current_state` endpoint.
49    #[response(error = crate::Error)]
50    pub struct Response {
51        /// The private data that this user has attached to this room.
52        #[serde(default, skip_serializing_if = "Vec::is_empty")]
53        pub account_data: Vec<Raw<AnyRoomAccountDataEvent>>,
54
55        /// The user’s membership state in this room.
56        #[serde(skip_serializing_if = "Option::is_none")]
57        pub membership: Option<MembershipState>,
58
59        /// The pagination chunk for this room.
60        #[serde(skip_serializing_if = "Option::is_none")]
61        pub messages: Option<PaginationChunk>,
62
63        /// The room ID for this room.
64        pub room_id: OwnedRoomId,
65
66        /// The state of the room.
67        ///
68        /// If the user is a member of the room this will be the current state of the room as a
69        /// list of events.
70        ///
71        /// If the user has left the room this will be the state of the room when they left it.
72        #[serde(default, skip_serializing_if = "Vec::is_empty")]
73        pub state: Vec<Raw<AnyStateEvent>>,
74
75        /// Whether this room is visible to the `/publicRooms` API or not.
76        #[serde(skip_serializing_if = "Option::is_none")]
77        pub visibility: Option<Visibility>,
78    }
79
80    impl Response {
81        /// Creates a `Response` for the given room.
82        pub fn new(room_id: OwnedRoomId) -> Self {
83            Self {
84                room_id,
85                account_data: Vec::new(),
86                membership: None,
87                messages: None,
88                state: Vec::new(),
89                visibility: None,
90            }
91        }
92    }
93
94    /// A paginated chunk of messages from the room's timeline.
95    #[derive(Debug, Clone, Deserialize, Serialize)]
96    #[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
97    pub struct PaginationChunk {
98        /// An array of events.
99        ///
100        /// If the user is a member of the room this will be a list of the most recent messages for
101        /// this room.
102        ///
103        /// If the user has left the room this will be the messages that preceded them leaving.
104        pub chunk: Vec<Raw<AnyTimelineEvent>>,
105
106        ///  A token which correlates to the end of chunk.
107        ///
108        /// Can be passed to [`listen_to_new_events`] to listen to new events and to
109        /// [`get_message_events`] to retrieve later events.
110        ///
111        /// [`listen_to_new_events`]: crate::peeking::listen_to_new_events
112        /// [`get_message_events`]: crate::message::get_message_events
113        pub end: String,
114
115        /// A token which correlates to the start of chunk. Can be passed to [`get_message_events`]
116        /// to retrieve earlier events.
117        ///
118        /// If no earlier events are available, this property may be omitted from the response.
119        ///
120        /// [`get_message_events`]: crate::message::get_message_events
121        #[serde(skip_serializing_if = "Option::is_none")]
122        pub start: Option<String>,
123    }
124
125    impl PaginationChunk {
126        /// Construct a new `PaginationChunk` with the given events and end token.
127        pub fn new(chunk: Vec<Raw<AnyTimelineEvent>>, end: String) -> Self {
128            Self { chunk, end, start: None }
129        }
130    }
131}
ruma_client_api/peeking/get_current_state.rs

ruma_client_api/peeking/
get_current_state.rs
