logo
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

//! `POST /_matrix/client/*/rooms/{roomId}/read_markers`

pub mod v3 {
    //! `/v3/` ([spec])
    //!
    //! This endpoint is equivalent to calling the [`create_receipt`] endpoint,
    //! but is provided as a way to update several read markers with a single call.
    //!
    //! [spec]: https://spec.matrix.org/v1.2/client-server-api/#post_matrixclientv3roomsroomidread_markers
    //! [`create_receipt`]: crate::receipt::create_receipt

    use ruma_common::{api::ruma_api, EventId, RoomId};

    ruma_api! {
        metadata: {
            description: "Sets the position of the read marker for a given room, and optionally the read receipt's location.",
            method: POST,
            name: "set_read_marker",
            r0_path: "/_matrix/client/r0/rooms/:room_id/read_markers",
            stable_path: "/_matrix/client/v3/rooms/:room_id/read_markers",
            rate_limited: true,
            authentication: AccessToken,
            added: 1.0,
        }

        request: {
            /// The room ID to set the read marker in for the user.
            #[ruma_api(path)]
            pub room_id: &'a RoomId,

            /// The event ID the fully-read marker should be located at.
            ///
            /// The event MUST belong to the room.
            ///
            /// With the `unstable-msc2285` feature, this field is optional.
            #[cfg(not(feature = "unstable-msc2285"))]
            #[serde(rename = "m.fully_read")]
            pub fully_read: &'a EventId,

            /// The event ID the fully-read marker should be located at.
            ///
            /// The event MUST belong to the room.
            ///
            /// This is equivalent to calling the [`create_receipt`] endpoint with a
            /// [`ReceiptType::FullyRead`].
            ///
            /// Without the `unstable-msc2285` feature, this field is required.
            ///
            /// [`create_receipt`]: crate::receipt::create_receipt
            /// [`ReceiptType::FullyRead`]: crate::receipt::create_receipt::v3::ReceiptType::FullyRead
            #[cfg(feature = "unstable-msc2285")]
            #[serde(rename = "m.fully_read")]
            pub fully_read: Option<&'a EventId>,

            /// The event ID to set the public read receipt location at.
            ///
            /// This is equivalent to calling the [`create_receipt`] endpoint with a
            /// [`ReceiptType::Read`].
            ///
            /// [`create_receipt`]: crate::receipt::create_receipt
            /// [`ReceiptType::Read`]: crate::receipt::create_receipt::v3::ReceiptType::Read
            #[serde(rename = "m.read", skip_serializing_if = "Option::is_none")]
            pub read_receipt: Option<&'a EventId>,

            /// The event ID to set the private read receipt location at.
            ///
            /// This is equivalent to calling the [`create_receipt`] endpoint with a
            /// [`ReceiptType::ReadPrivate`].
            ///
            /// [`create_receipt`]: crate::receipt::create_receipt
            /// [`ReceiptType::ReadPrivate`]: crate::receipt::create_receipt::v3::ReceiptType::ReadPrivate
            #[cfg(feature = "unstable-msc2285")]
            #[serde(rename = "org.matrix.msc2285.read.private", alias = "m.read.private", skip_serializing_if = "Option::is_none")]
            pub private_read_receipt: Option<&'a EventId>,
        }

        #[derive(Default)]
        response: {}

        error: crate::Error
    }

    impl<'a> Request<'a> {
        /// Creates a new `Request` with the given room ID and fully read event ID.
        ///
        /// With the `unstable-msc2285` feature, this method doesn't have the `fully_read`
        /// parameter.
        #[cfg(not(feature = "unstable-msc2285"))]
        pub fn new(room_id: &'a RoomId, fully_read: &'a EventId) -> Self {
            Self { room_id, fully_read, read_receipt: None }
        }

        /// Creates a new `Request` with the given room ID.
        ///
        /// Without the `unstable-msc2285` feature, this method takes a `fully_read` parameter.
        #[cfg(feature = "unstable-msc2285")]
        pub fn new(room_id: &'a RoomId) -> Self {
            Self { room_id, fully_read: None, read_receipt: None, private_read_receipt: None }
        }
    }

    impl Response {
        /// Creates an empty `Response`.
        pub fn new() -> Self {
            Self {}
        }
    }
}