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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
//! `GET /_matrix/client/*/rooms/{roomId}/members`
//!
//! Get membership events for a room.
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3roomsroomidmembers
use ruma_common::{
OwnedRoomId,
api::{auth_scheme::AccessToken, request, response},
metadata,
serde::Raw,
};
use ruma_events::room::member::{MembershipState, RoomMemberEvent};
metadata! {
method: GET,
rate_limited: false,
authentication: AccessToken,
history: {
1.0 => "/_matrix/client/r0/rooms/{room_id}/members",
1.1 => "/_matrix/client/v3/rooms/{room_id}/members",
}
}
/// Request type for the `get_member_events` endpoint.
#[request(error = crate::Error)]
pub struct Request {
/// The room to get the member events for.
#[ruma_api(path)]
pub room_id: OwnedRoomId,
/// The point in time (pagination token) to return members for in the room.
///
/// This token can be obtained from a prev_batch token returned for each room by the sync
/// API.
#[serde(skip_serializing_if = "Option::is_none")]
#[ruma_api(query)]
pub at: Option<String>,
/// The kind of memberships to filter for.
///
/// Defaults to no filtering if unspecified. When specified alongside not_membership, the
/// two parameters create an 'or' condition: either the membership is the same as
/// membership or is not the same as not_membership.
#[serde(skip_serializing_if = "Option::is_none")]
#[ruma_api(query)]
pub membership: Option<MembershipState>,
/// The kind of memberships to *exclude* from the results.
///
/// Defaults to no filtering if unspecified.
#[serde(skip_serializing_if = "Option::is_none")]
#[ruma_api(query)]
pub not_membership: Option<MembershipState>,
}
/// Response type for the `get_member_events` endpoint.
#[response(error = crate::Error)]
pub struct Response {
/// A list of member events.
pub chunk: Vec<Raw<RoomMemberEvent>>,
}
impl Request {
/// Creates a new `Request` with the given room ID.
pub fn new(room_id: OwnedRoomId) -> Self {
Self { room_id, at: None, membership: None, not_membership: None }
}
}
impl Response {
/// Creates a new `Response` with the given member event chunk.
pub fn new(chunk: Vec<Raw<RoomMemberEvent>>) -> Self {
Self { chunk }
}
}
#[cfg(all(test, feature = "server"))]
mod tests {
use ruma_common::api::IncomingRequest as _;
use super::{MembershipState, Request};
#[test]
fn deserialization() {
let uri = http::Uri::builder()
.scheme("https")
.authority("example.org")
.path_and_query(
"/_matrix/client/r0/rooms/!dummy%3Aexample.org/members\
?not_membership=leave\
&at=1026",
)
.build()
.unwrap();
let req = Request::try_from_http_request(
http::Request::builder().uri(uri).body(&[] as &[u8]).unwrap(),
&["!dummy:example.org"],
)
.unwrap();
assert_eq!(req.room_id, "!dummy:example.org");
assert_eq!(req.at.as_deref(), Some("1026"));
assert_eq!(req.membership, None);
assert_eq!(req.not_membership, Some(MembershipState::Leave));
}
}
}