ruma_federation_api/membership/
prepare_leave_event.rs

Help
1//! `GET /_matrix/federation/*/make_leave/{roomId}/{userId}`
2//!
3//! Asks the receiving server to return information that the sending server will need to prepare a
4//! leave event to get out of the room.
5
6pub mod v1 {
7    //! `/v1/` ([spec])
8    //!
9    //! [spec]: https://spec.matrix.org/latest/server-server-api/#get_matrixfederationv1make_leaveroomiduserid
10
11    use ruma_common::{
12        api::{request, response, Metadata},
13        metadata, OwnedRoomId, OwnedUserId, RoomVersionId,
14    };
15    use serde_json::value::RawValue as RawJsonValue;
16
17    const METADATA: Metadata = metadata! {
18        method: GET,
19        rate_limited: false,
20        authentication: ServerSignatures,
21        history: {
22            1.0 => "/_matrix/federation/v1/make_leave/:room_id/:user_id",
23        }
24    };
25
26    /// Request type for the `get_leave_event` endpoint.
27    #[request]
28    pub struct Request {
29        /// The room ID that is about to be left.
30        #[ruma_api(path)]
31        pub room_id: OwnedRoomId,
32
33        /// The user ID the leave event will be for.
34        #[ruma_api(path)]
35        pub user_id: OwnedUserId,
36    }
37
38    /// Response type for the `get_leave_event` endpoint.
39    #[response]
40    pub struct Response {
41        /// The version of the room where the server is trying to leave.
42        ///
43        /// If not provided, the room version is assumed to be either "1" or "2".
44        pub room_version: Option<RoomVersionId>,
45
46        /// An unsigned template event.
47        ///
48        /// Note that events have a different format depending on the room version - check the room
49        /// version specification for precise event formats.
50        pub event: Box<RawJsonValue>,
51    }
52
53    impl Request {
54        /// Creates a new `Request` with:
55        /// * the room ID that is about to be left.
56        /// * the user ID the leave event will be for.
57        pub fn new(room_id: OwnedRoomId, user_id: OwnedUserId) -> Self {
58            Self { room_id, user_id }
59        }
60    }
61
62    impl Response {
63        /// Creates a new `Response` with:
64        /// * the version of the room where the server is trying to leave.
65        /// * an unsigned template event.
66        pub fn new(room_version: Option<RoomVersionId>, event: Box<RawJsonValue>) -> Self {
67            Self { room_version, event }
68        }
69    }
70}
ruma_federation_api/membership/prepare_leave_event.rs

ruma_federation_api/membership/
prepare_leave_event.rs
