ruma_client_api/room/
get_summary.rs

1//! `GET /_matrix/client/v1/summary/{roomIdOrAlias}`
2//!
3//! Experimental API enabled with MSC3266.
4//!
5//! Returns a short description of the state of a room.
6
7pub mod msc3266 {
8    //! `MSC3266` ([MSC])
9    //!
10    //! [MSC]: https://github.com/matrix-org/matrix-spec-proposals/pull/3266
11
12    use js_int::UInt;
13    use ruma_common::{
14        api::{request, response, Metadata},
15        metadata,
16        room::RoomType,
17        space::SpaceRoomJoinRule,
18        EventEncryptionAlgorithm, OwnedMxcUri, OwnedRoomAliasId, OwnedRoomId, OwnedRoomOrAliasId,
19        OwnedServerName, RoomVersionId,
20    };
21    use ruma_events::room::member::MembershipState;
22
23    const METADATA: Metadata = metadata! {
24        method: GET,
25        rate_limited: false,
26        authentication: AccessTokenOptional,
27        history: {
28            unstable => "/_matrix/client/unstable/im.nheko.summary/rooms/:room_id_or_alias/summary",
29        }
30    };
31
32    /// Request type for the `get_summary` endpoint.
33    #[request(error = crate::Error)]
34    pub struct Request {
35        /// Alias or ID of the room to be summarized.
36        #[ruma_api(path)]
37        pub room_id_or_alias: OwnedRoomOrAliasId,
38
39        /// A list of servers the homeserver should attempt to use to peek at the room.
40        ///
41        /// Defaults to an empty `Vec`.
42        #[serde(default, skip_serializing_if = "Vec::is_empty")]
43        #[ruma_api(query)]
44        pub via: Vec<OwnedServerName>,
45    }
46
47    /// Response type for the `get_summary` endpoint.
48    #[response(error = crate::Error)]
49    pub struct Response {
50        /// ID of the room (useful if it's an alias).
51        pub room_id: OwnedRoomId,
52
53        /// The canonical alias for this room, if set.
54        #[serde(skip_serializing_if = "Option::is_none")]
55        pub canonical_alias: Option<OwnedRoomAliasId>,
56
57        /// Avatar of the room.
58        #[serde(skip_serializing_if = "Option::is_none")]
59        pub avatar_url: Option<OwnedMxcUri>,
60
61        /// Whether guests can join the room.
62        pub guest_can_join: bool,
63
64        /// Name of the room.
65        #[serde(skip_serializing_if = "Option::is_none")]
66        pub name: Option<String>,
67
68        /// Member count of the room.
69        pub num_joined_members: UInt,
70
71        /// Topic of the room.
72        #[serde(skip_serializing_if = "Option::is_none")]
73        pub topic: Option<String>,
74
75        /// Whether the room history can be read without joining.
76        pub world_readable: bool,
77
78        /// Join rule of the room.
79        pub join_rule: SpaceRoomJoinRule,
80
81        /// Type of the room, if any.
82        #[serde(skip_serializing_if = "Option::is_none")]
83        pub room_type: Option<RoomType>,
84
85        /// Version of the room.
86        #[serde(skip_serializing_if = "Option::is_none")]
87        pub room_version: Option<RoomVersionId>,
88
89        /// The current membership of this user in the room.
90        ///
91        /// This field will not be present when called unauthenticated, but is required when called
92        /// authenticated. It should be `leave` if the server doesn't know about the room, since
93        /// for all other membership states the server would know about the room already.
94        #[serde(skip_serializing_if = "Option::is_none")]
95        pub membership: Option<MembershipState>,
96
97        /// If the room is encrypted, the algorithm used for this room.
98        #[serde(skip_serializing_if = "Option::is_none")]
99        pub encryption: Option<EventEncryptionAlgorithm>,
100    }
101
102    impl Request {
103        /// Creates a new `Request` with the given room or alias ID and via server names.
104        pub fn new(room_id_or_alias: OwnedRoomOrAliasId, via: Vec<OwnedServerName>) -> Self {
105            Self { room_id_or_alias, via }
106        }
107    }
108
109    impl Response {
110        /// Creates a new [`Response`] with all the mandatory fields set.
111        pub fn new(
112            room_id: OwnedRoomId,
113            join_rule: SpaceRoomJoinRule,
114            guest_can_join: bool,
115            num_joined_members: UInt,
116            world_readable: bool,
117        ) -> Self {
118            Self {
119                room_id,
120                canonical_alias: None,
121                avatar_url: None,
122                guest_can_join,
123                name: None,
124                num_joined_members,
125                topic: None,
126                world_readable,
127                join_rule,
128                room_type: None,
129                room_version: None,
130                membership: None,
131                encryption: None,
132            }
133        }
134    }
135}
ruma_client_api/room/get_summary.rs

ruma_client_api/room/
get_summary.rs
