ruma-client-api 0.16.0

Types for the endpoints in the Matrix client-server API.
Documentation 
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

//! `POST /_matrix/client/*/rooms/{roomId}/read_markers`
//!
//! Sets the position of the read marker for a given room, and optionally the read receipt's
//! location.

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.4/client-server-api/#post_matrixclientv3roomsroomidread_markers
    //! [`create_receipt`]: crate::receipt::create_receipt

    use ruma_common::{
        api::{request, response, Metadata},
        metadata, OwnedEventId, OwnedRoomId,
    };

    const METADATA: Metadata = metadata! {
        method: POST,
        rate_limited: true,
        authentication: AccessToken,
        history: {
            1.0 => "/_matrix/client/r0/rooms/:room_id/read_markers",
            1.1 => "/_matrix/client/v3/rooms/:room_id/read_markers",
        }
    };

    /// Request type for the `set_read_marker` endpoint.
    #[request(error = crate::Error)]
    pub struct Request {
        /// The room ID to set the read marker in for the user.
        #[ruma_api(path)]
        pub room_id: OwnedRoomId,

        /// 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`].
        ///
        /// [`create_receipt`]: crate::receipt::create_receipt
        /// [`ReceiptType::FullyRead`]: crate::receipt::create_receipt::v3::ReceiptType::FullyRead
        #[serde(rename = "m.fully_read", skip_serializing_if = "Option::is_none")]
        pub fully_read: Option<OwnedEventId>,

        /// 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<OwnedEventId>,

        /// 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
        #[serde(rename = "m.read.private", skip_serializing_if = "Option::is_none")]
        pub private_read_receipt: Option<OwnedEventId>,
    }

    /// Response type for the `set_read_marker` endpoint.
    #[response(error = crate::Error)]
    #[derive(Default)]
    pub struct Response {}

    impl Request {
        /// Creates a new `Request` with the given room ID.
        pub fn new(room_id: OwnedRoomId) -> 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 {}
        }
    }
}