ruma_client_api/tag/
delete_tag.rs

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

ruma_client_api/tag/
delete_tag.rs
