ruma_federation_api/thirdparty/
exchange_invite.rs

Help
1//! `PUT /_matrix/federation/*/exchange_third_party_invite/{roomId}`
2//!
3//! The receiving server will verify the partial `m.room.member` event given in the request body.
4//! If valid, the receiving server will issue an invite as per the [Inviting to a room] section
5//! before returning a response to this request.
6//!
7//! [Inviting to a room]: https://spec.matrix.org/latest/server-server-api/#inviting-to-a-room
8
9pub mod v1 {
10    //! `/v1/` ([spec])
11    //!
12    //! [spec]: https://spec.matrix.org/latest/server-server-api/#put_matrixfederationv1exchange_third_party_inviteroomid
13
14    use ruma_common::{
15        api::{request, response, Metadata},
16        metadata, OwnedRoomId, OwnedUserId,
17    };
18    use ruma_events::{room::member::ThirdPartyInvite, StateEventType};
19
20    const METADATA: Metadata = metadata! {
21        method: PUT,
22        rate_limited: false,
23        authentication: AccessToken,
24        history: {
25            1.0 => "/_matrix/federation/v1/exchange_third_party_invite/:room_id",
26        }
27    };
28
29    /// Request type for the `exchange_invite` endpoint.
30    #[request]
31    pub struct Request {
32        /// The room ID to exchange a third party invite in.
33        #[ruma_api(path)]
34        pub room_id: OwnedRoomId,
35
36        /// The event type.
37        ///
38        /// Must be `StateEventType::RoomMember`.
39        #[serde(rename = "type")]
40        pub kind: StateEventType,
41
42        /// The user ID of the user who sent the original invite event.
43        pub sender: OwnedUserId,
44
45        /// The user ID of the invited user.
46        pub state_key: OwnedUserId,
47
48        /// The content of the invite event.
49        pub content: ThirdPartyInvite,
50    }
51
52    /// Response type for the `exchange_invite` endpoint.
53    #[response]
54    #[derive(Default)]
55    pub struct Response {}
56
57    impl Request {
58        /// Creates a new `Request` for a third party invite exchange
59        pub fn new(
60            room_id: OwnedRoomId,
61            sender: OwnedUserId,
62            state_key: OwnedUserId,
63            content: ThirdPartyInvite,
64        ) -> Self {
65            Self { room_id, kind: StateEventType::RoomMember, sender, state_key, content }
66        }
67    }
68
69    impl Response {
70        /// Creates a new `Response`.
71        pub fn new() -> Self {
72            Self {}
73        }
74    }
75}
ruma_federation_api/thirdparty/exchange_invite.rs

ruma_federation_api/thirdparty/
exchange_invite.rs
