ruma_federation_api/knock/
send_knock.rs

Help
1//! `PUT /_matrix/federation/*/send_knock/{roomId}/{eventId}`
2//!
3//! Submits a signed knock event to the resident homeserver for it to accept into the room's graph.
4
5pub mod v1 {
6    //! `/v1/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/server-server-api/#put_matrixfederationv1send_knockroomideventid
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata,
13        serde::Raw,
14        OwnedEventId, OwnedRoomId,
15    };
16    use ruma_events::AnyStrippedStateEvent;
17    use serde_json::value::RawValue as RawJsonValue;
18
19    const METADATA: Metadata = metadata! {
20        method: PUT,
21        rate_limited: false,
22        authentication: ServerSignatures,
23        history: {
24            unstable => "/_matrix/federation/unstable/xyz.amorgan.knock/send_knock/:room_id/:event_id",
25            1.1 => "/_matrix/federation/v1/send_knock/:room_id/:event_id",
26        }
27    };
28
29    /// Request type for the `send_knock` endpoint.
30    #[request]
31    pub struct Request {
32        /// The room ID that should receive the knock.
33        #[ruma_api(path)]
34        pub room_id: OwnedRoomId,
35
36        /// The event ID for the knock event.
37        #[ruma_api(path)]
38        pub event_id: OwnedEventId,
39
40        /// The PDU.
41        #[ruma_api(body)]
42        pub pdu: Box<RawJsonValue>,
43    }
44
45    /// Response type for the `send_knock` endpoint.
46    #[response]
47    pub struct Response {
48        /// State events providing public room metadata.
49        pub knock_room_state: Vec<Raw<AnyStrippedStateEvent>>,
50    }
51
52    impl Request {
53        /// Creates a new `Request` with the given room ID, event ID and knock event.
54        pub fn new(room_id: OwnedRoomId, event_id: OwnedEventId, pdu: Box<RawJsonValue>) -> Self {
55            Self { room_id, event_id, pdu }
56        }
57    }
58
59    impl Response {
60        /// Creates a new `Response` with the given public room metadata state events.
61        pub fn new(knock_room_state: Vec<Raw<AnyStrippedStateEvent>>) -> Self {
62            Self { knock_room_state }
63        }
64    }
65}
ruma_federation_api/knock/send_knock.rs

ruma_federation_api/knock/
send_knock.rs
