ruma_federation_api/membership/
prepare_join_event.rs

1//! `GET /_matrix/federation/*/make_join/{roomId}/{userId}`
2//!
3//! Send a request for a join event template to a resident server.
4
5pub mod v1 {
6    //! `/v1/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/server-server-api/#get_matrixfederationv1make_joinroomiduserid
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata, OwnedRoomId, OwnedUserId, RoomVersionId,
13    };
14    use serde_json::value::RawValue as RawJsonValue;
15
16    const METADATA: Metadata = metadata! {
17        method: GET,
18        rate_limited: false,
19        authentication: ServerSignatures,
20        history: {
21            1.0 => "/_matrix/federation/v1/make_join/:room_id/:user_id",
22        }
23    };
24
25    /// Request type for the `create_join_event_template` endpoint.
26    #[request]
27    pub struct Request {
28        /// The room ID that is about to be joined.
29        #[ruma_api(path)]
30        pub room_id: OwnedRoomId,
31
32        /// The user ID the join event will be for.
33        #[ruma_api(path)]
34        pub user_id: OwnedUserId,
35
36        /// The room versions the sending server has support for.
37        ///
38        /// Defaults to `&[RoomVersionId::V1]`.
39        #[ruma_api(query)]
40        #[serde(default = "default_ver", skip_serializing_if = "is_default_ver")]
41        pub ver: Vec<RoomVersionId>,
42    }
43
44    /// Response type for the `create_join_event_template` endpoint.
45    #[response]
46    pub struct Response {
47        /// The version of the room where the server is trying to join.
48        #[serde(skip_serializing_if = "Option::is_none")]
49        pub room_version: Option<RoomVersionId>,
50
51        /// An unsigned template event.
52        pub event: Box<RawJsonValue>,
53    }
54
55    fn default_ver() -> Vec<RoomVersionId> {
56        vec![RoomVersionId::V1]
57    }
58
59    fn is_default_ver(ver: &[RoomVersionId]) -> bool {
60        *ver == [RoomVersionId::V1]
61    }
62
63    impl Request {
64        /// Creates a new `Request` with the given room id and user id.
65        pub fn new(room_id: OwnedRoomId, user_id: OwnedUserId) -> Self {
66            Self { room_id, user_id, ver: vec![RoomVersionId::V1] }
67        }
68    }
69
70    impl Response {
71        /// Creates a new `Response` with the given template event.
72        pub fn new(event: Box<RawJsonValue>) -> Self {
73            Self { room_version: None, event }
74        }
75    }
76}
ruma_federation_api/membership/prepare_join_event.rs

ruma_federation_api/membership/
prepare_join_event.rs
