ruma-client-api 0.14.1

Types for the endpoints in the Matrix client-server API.
Documentation 
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

//! `POST /_matrix/client/*/rooms/{roomId}/report/{eventId}`

pub mod v3 {
    //! `/v3/` ([spec])
    //!
    //! [spec]: https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3roomsroomidreporteventid

    use js_int::Int;
    use ruma_common::{api::ruma_api, EventId, RoomId};

    ruma_api! {
        metadata: {
            description: "Report content as inappropriate.",
            method: POST,
            name: "report_content",
            r0_path: "/_matrix/client/r0/rooms/:room_id/report/:event_id",
            stable_path: "/_matrix/client/v3/rooms/:room_id/report/:event_id",
            rate_limited:  false,
            authentication: AccessToken,
            added: 1.0,
        }

        request: {
            /// Room in which the event to be reported is located.
            #[ruma_api(path)]
            pub room_id: &'a RoomId,

            /// Event to report.
            #[ruma_api(path)]
            pub event_id: &'a EventId,

            /// Integer between -100 and 0 rating offensivness.
            pub score: Option<Int>,

            /// Reason to report content.
            ///
            /// May be blank.
            pub reason: Option<&'a str>,
        }

        #[derive(Default)]
        response: {}

        error: crate::Error
    }

    impl<'a> Request<'a> {
        /// Creates a new `Request` with the given room ID, event ID, score and reason.
        pub fn new(
            room_id: &'a RoomId,
            event_id: &'a EventId,
            score: Option<Int>,
            reason: Option<&'a str>,
        ) -> Self {
            Self { room_id, event_id, score, reason }
        }
    }

    impl Response {
        /// Creates an empty `Response`.
        pub fn new() -> Self {
            Self {}
        }
    }
}