ruma_federation_api/membership/create_invite/
v2.rs

Help
1//! `/v2/` ([spec])
2//!
3//! [spec]: https://spec.matrix.org/latest/server-server-api/#put_matrixfederationv2inviteroomideventid
4
5#[cfg(feature = "unstable-msc4125")]
6use ruma_common::OwnedServerName;
7use ruma_common::{
8    api::{request, response, Metadata},
9    metadata,
10    serde::Raw,
11    OwnedEventId, OwnedRoomId, RoomVersionId,
12};
13use ruma_events::AnyStrippedStateEvent;
14use serde_json::value::RawValue as RawJsonValue;
15
16const METADATA: Metadata = metadata! {
17    method: PUT,
18    rate_limited: false,
19    authentication: ServerSignatures,
20    history: {
21        1.0 => "/_matrix/federation/v2/invite/:room_id/:event_id",
22    }
23};
24
25/// Request type for the `create_invite` endpoint.
26#[request]
27pub struct Request {
28    /// The room ID that the user is being invited to.
29    #[ruma_api(path)]
30    pub room_id: OwnedRoomId,
31
32    /// The event ID for the invite event, generated by the inviting server.
33    #[ruma_api(path)]
34    pub event_id: OwnedEventId,
35
36    /// The version of the room where the user is being invited to.
37    pub room_version: RoomVersionId,
38
39    /// The invite event which needs to be signed.
40    pub event: Box<RawJsonValue>,
41
42    /// An optional list of simplified events to help the receiver of the invite identify the room.
43    pub invite_room_state: Vec<Raw<AnyStrippedStateEvent>>,
44
45    /// An optional list of servers the invited homeserver should attempt to join or leave via,
46    /// according to [MSC4125](https://github.com/matrix-org/matrix-spec-proposals/pull/4125).
47    ///
48    /// If present, it must not be empty.
49    #[cfg(feature = "unstable-msc4125")]
50    #[serde(skip_serializing_if = "Option::is_none", rename = "org.matrix.msc4125.via")]
51    pub via: Option<Vec<OwnedServerName>>,
52}
53
54/// Response type for the `create_invite` endpoint.
55#[response]
56pub struct Response {
57    /// The signed invite event.
58    pub event: Box<RawJsonValue>,
59}
60
61impl Request {
62    /// Creates a new `Request` with the given room ID, event ID, room version, event and invite
63    /// room state.
64    pub fn new(
65        room_id: OwnedRoomId,
66        event_id: OwnedEventId,
67        room_version: RoomVersionId,
68        event: Box<RawJsonValue>,
69        invite_room_state: Vec<Raw<AnyStrippedStateEvent>>,
70    ) -> Self {
71        Self {
72            room_id,
73            event_id,
74            room_version,
75            event,
76            invite_room_state,
77            #[cfg(feature = "unstable-msc4125")]
78            via: None,
79        }
80    }
81}
82
83impl Response {
84    /// Creates a new `Response` with the given invite event.
85    pub fn new(event: Box<RawJsonValue>) -> Self {
86        Self { event }
87    }
88}
ruma_federation_api/membership/create_invite/v2.rs

ruma_federation_api/membership/create_invite/
v2.rs
