ruma_client_api/redact/
redact_event.rs

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
//! `PUT /_matrix/client/*/rooms/{roomId}/redact/{eventId}/{txnId}`

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

    use ruma_common::{api::ruma_api, EventId, OwnedEventId, RoomId, TransactionId};

    ruma_api! {
        metadata: {
            description: "Redact an event, stripping all information not critical to the event graph integrity.",
            method: PUT,
            name: "redact_event",
            r0_path: "/_matrix/client/r0/rooms/:room_id/redact/:event_id/:txn_id",
            stable_path: "/_matrix/client/v3/rooms/:room_id/redact/:event_id/:txn_id",
            rate_limited: false,
            authentication: AccessToken,
            added: 1.0,
        }

        request: {
            /// The ID of the room of the event to redact.
            #[ruma_api(path)]
            pub room_id: &'a RoomId,

            /// The ID of the event to redact.
            #[ruma_api(path)]
            pub event_id: &'a EventId,

            /// The transaction ID for this event.
            ///
            /// Clients should generate a unique ID; it will be used by the server to ensure idempotency
            /// of requests.
            #[ruma_api(path)]
            pub txn_id: &'a TransactionId,

            /// The reason for the redaction.
            #[serde(skip_serializing_if = "Option::is_none")]
            pub reason: Option<&'a str>,
        }

        response: {
            /// The ID of the redacted event.
            pub event_id: OwnedEventId,
        }

        error: crate::Error
    }

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

    impl Response {
        /// Creates a new `Response` with the given event ID.
        pub fn new(event_id: OwnedEventId) -> Self {
            Self { event_id }
        }
    }
}