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
//! `POST /_matrix/client/*/rooms/{roomId}/ban`
//!
//! Ban a user from a room.
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3roomsroomidban
use ruma_common::{
api::{request, response, Metadata},
metadata, OwnedRoomId, OwnedUserId,
};
const METADATA: 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(error = crate::Error)]
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>,
}
/// Response type for the `ban_user` endpoint.
#[response(error = crate::Error)]
#[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 }
}
}
impl Response {
/// Creates an empty `Response`.
pub fn new() -> Self {
Self {}
}
}
}