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

ruma_federation_api/membership/
prepare_join_event.rs
