ruma_client_api/room/
report_content.rs

Help
1//! `POST /_matrix/client/*/rooms/{roomId}/report/{eventId}`
2//!
3//! Report content as inappropriate.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3roomsroomidreporteventid
9
10    use js_int::Int;
11    use ruma_common::{
12        api::{request, response, Metadata},
13        metadata, OwnedEventId, OwnedRoomId,
14    };
15
16    const METADATA: Metadata = metadata! {
17        method: POST,
18        rate_limited: false,
19        authentication: AccessToken,
20        history: {
21            1.0 => "/_matrix/client/r0/rooms/:room_id/report/:event_id",
22            1.1 => "/_matrix/client/v3/rooms/:room_id/report/:event_id",
23        }
24    };
25
26    /// Request type for the `report_content` endpoint.
27    #[request(error = crate::Error)]
28    pub struct Request {
29        /// Room in which the event to be reported is located.
30        #[ruma_api(path)]
31        pub room_id: OwnedRoomId,
32
33        /// Event to report.
34        #[ruma_api(path)]
35        pub event_id: OwnedEventId,
36
37        /// Integer between -100 and 0 rating offensivness.
38        #[serde(skip_serializing_if = "Option::is_none")]
39        pub score: Option<Int>,
40
41        /// Reason to report content.
42        #[serde(skip_serializing_if = "Option::is_none")]
43        pub reason: Option<String>,
44    }
45
46    /// Response type for the `report_content` endpoint.
47    #[response(error = crate::Error)]
48    #[derive(Default)]
49    pub struct Response {}
50
51    impl Request {
52        /// Creates a new `Request` with the given room ID, event ID, score and reason.
53        pub fn new(
54            room_id: OwnedRoomId,
55            event_id: OwnedEventId,
56            score: Option<Int>,
57            reason: Option<String>,
58        ) -> Self {
59            Self { room_id, event_id, score, reason }
60        }
61    }
62
63    impl Response {
64        /// Creates an empty `Response`.
65        pub fn new() -> Self {
66            Self {}
67        }
68    }
69}
ruma_client_api/room/report_content.rs

ruma_client_api/room/
report_content.rs
