ruma_client_api/membership/
kick_user.rs

1//! `POST /_matrix/client/*/rooms/{roomId}/kick`
2//!
3//! Kick a user from a room.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3roomsroomidkick
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata, OwnedRoomId, OwnedUserId,
13    };
14
15    const METADATA: Metadata = metadata! {
16        method: POST,
17        rate_limited: false,
18        authentication: AccessToken,
19        history: {
20            1.0 => "/_matrix/client/r0/rooms/:room_id/kick",
21            1.1 => "/_matrix/client/v3/rooms/:room_id/kick",
22        }
23    };
24
25    /// Request type for the `kick_user` endpoint.
26    #[request(error = crate::Error)]
27    pub struct Request {
28        /// The room to kick the user from.
29        #[ruma_api(path)]
30        pub room_id: OwnedRoomId,
31
32        /// The user to kick.
33        pub user_id: OwnedUserId,
34
35        /// The reason for kicking the user.
36        #[serde(skip_serializing_if = "Option::is_none")]
37        pub reason: Option<String>,
38    }
39
40    /// Response type for the `kick_user` endpoint.
41    #[response(error = crate::Error)]
42    #[derive(Default)]
43    pub struct Response {}
44
45    impl Request {
46        /// Creates a new `Request` with the given room id and room id.
47        pub fn new(room_id: OwnedRoomId, user_id: OwnedUserId) -> Self {
48            Self { room_id, user_id, reason: None }
49        }
50    }
51
52    impl Response {
53        /// Creates an empty `Response`.
54        pub fn new() -> Self {
55            Self {}
56        }
57    }
58}