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
//! `POST /_matrix/client/*/rooms/{roomId}/ban`
//!
//! Ban a user from a room.
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/v1.18/client-server-api/#post_matrixclientv3roomsroomidban
use ruma_common::{
OwnedRoomId, OwnedUserId,
api::{auth_scheme::AccessToken, request, response},
metadata,
};
metadata! {
method: POST,
rate_limited: false,
authentication: AccessToken,
history: {
1.0 => "/_matrix/client/r0/rooms/{room_id}/ban",
1.1 => "/_matrix/client/v3/rooms/{room_id}/ban",
}
}
/// Request type for the `ban_user` endpoint.
#[request]
pub struct Request {
/// The room to kick the user from.
#[ruma_api(path)]
pub room_id: OwnedRoomId,
/// The user to ban.
pub user_id: OwnedUserId,
/// The reason for banning the user.
#[serde(skip_serializing_if = "Option::is_none")]
pub reason: Option<String>,
/// A flag indicating whether all the user's events should be immediately redacted.
///
/// This uses the unstable prefix defined in [MSC4293].
///
/// [MSC4293]: https://github.com/matrix-org/matrix-spec-proposals/pull/4293
#[cfg(feature = "unstable-msc4293")]
#[serde(
rename = "org.matrix.msc4293.redact_events",
default,
skip_serializing_if = "ruma_common::serde::is_default"
)]
pub redact_events: bool,
}
/// Response type for the `ban_user` endpoint.
#[response]
#[derive(Default)]
pub struct Response {}
impl Request {
/// Creates a new `Request` with the given room id and room id.
pub fn new(room_id: OwnedRoomId, user_id: OwnedUserId) -> Self {
Self {
room_id,
user_id,
reason: None,
#[cfg(feature = "unstable-msc4293")]
redact_events: false,
}
}
}
impl Response {
/// Creates an empty `Response`.
pub fn new() -> Self {
Self {}
}
}
}