ruma_federation_api/membership/create_join_event/
v2.rs

Help
1//! `/v2/` ([spec])
2//!
3//! [spec]: https://spec.matrix.org/latest/server-server-api/#put_matrixfederationv2send_joinroomideventid
4
5use ruma_common::{
6    api::{request, response, Metadata},
7    metadata, OwnedEventId, OwnedRoomId,
8};
9use serde::{Deserialize, Serialize};
10use serde_json::value::RawValue as RawJsonValue;
11
12const METADATA: Metadata = metadata! {
13    method: PUT,
14    rate_limited: false,
15    authentication: ServerSignatures,
16    history: {
17        1.0 => "/_matrix/federation/v2/send_join/:room_id/:event_id",
18    }
19};
20
21/// Request type for the `create_join_event` endpoint.
22#[request]
23pub struct Request {
24    /// The room ID that is about to be joined.
25    ///
26    /// Do not use this. Instead, use the `room_id` field inside the PDU.
27    #[ruma_api(path)]
28    pub room_id: OwnedRoomId,
29
30    /// The event ID for the join event.
31    #[ruma_api(path)]
32    pub event_id: OwnedEventId,
33
34    /// The PDU.
35    #[ruma_api(body)]
36    pub pdu: Box<RawJsonValue>,
37
38    /// Indicates whether the calling server can accept a reduced response.
39    ///
40    /// If `true`, membership events are omitted from `state` and redundant events are omitted from
41    /// `auth_chain` in the response.
42    ///
43    /// If the room to be joined has no `m.room.name` nor `m.room.canonical_alias` events in its
44    /// current state, the resident server should determine the room members who would be
45    /// included in the `m.heroes` property of the room summary as defined in the [Client-Server
46    /// `/sync` response]. The resident server should include these members' membership events in
47    /// the response `state` field, and include the auth chains for these membership events in
48    /// the response `auth_chain` field.
49    ///
50    /// [Client-Server `/sync` response]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3sync
51    #[ruma_api(query)]
52    #[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
53    pub omit_members: bool,
54}
55
56/// Response type for the `create_join_event` endpoint.
57#[response]
58pub struct Response {
59    /// Full state of the room.
60    #[ruma_api(body)]
61    pub room_state: RoomState,
62}
63
64impl Request {
65    /// Creates a new `Request` from the given room ID, event ID and PDU.
66    pub fn new(room_id: OwnedRoomId, event_id: OwnedEventId, pdu: Box<RawJsonValue>) -> Self {
67        Self { room_id, event_id, pdu, omit_members: false }
68    }
69}
70
71impl Response {
72    /// Creates a new `Response` with the given room state.
73    pub fn new(room_state: RoomState) -> Self {
74        Self { room_state }
75    }
76}
77
78/// Full state of the room.
79#[derive(Clone, Debug, Default, Deserialize, Serialize)]
80#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
81pub struct RoomState {
82    /// Whether `m.room.member` events have been omitted from `state`.
83    ///
84    /// Defaults to `false`.
85    #[serde(default, skip_serializing_if = "ruma_common::serde::is_default")]
86    pub members_omitted: bool,
87
88    /// The full set of authorization events that make up the state of the room,
89    /// and their authorization events, recursively.
90    ///
91    /// If the request had `omit_members` set to `true`, then any events that are returned in
92    /// `state` may be omitted from `auth_chain`, whether or not membership events are omitted
93    /// from `state`.
94    pub auth_chain: Vec<Box<RawJsonValue>>,
95
96    /// The room state.
97    ///
98    /// If the request had `omit_members` set to `true`, events of type `m.room.member` may be
99    /// omitted from the response to reduce the size of the response. If this is done,
100    /// `members_omitted` must be set to `true`.
101    pub state: Vec<Box<RawJsonValue>>,
102
103    /// The signed copy of the membership event sent to other servers by the
104    /// resident server, including the resident server's signature.
105    ///
106    /// Required if the room version supports restricted join rules.
107    #[serde(skip_serializing_if = "Option::is_none")]
108    pub event: Option<Box<RawJsonValue>>,
109
110    /// A list of the servers active in the room (ie, those with joined members) before the join.
111    ///
112    /// Required if `members_omitted` is set to `true`.
113    #[serde(skip_serializing_if = "Option::is_none")]
114    pub servers_in_room: Option<Vec<String>>,
115}
116
117impl RoomState {
118    /// Creates an empty `RoomState`.
119    pub fn new() -> Self {
120        Self::default()
121    }
122}
ruma_federation_api/membership/create_join_event/v2.rs

ruma_federation_api/membership/create_join_event/
v2.rs
