ruma-client-api 0.23.1

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

//! `PUT /_matrix/client/*/rendezvous/{id}`
//!
//! Update a rendezvous session.

pub mod unstable {
    //! `unstable/io.element.msc4388` ([MSC])
    //!
    //! [MSC]: https://github.com/matrix-org/matrix-spec-proposals/pull/4388

    use ruma_common::{
        api::{auth_scheme::NoAccessToken, request, response},
        metadata,
    };

    metadata! {
        method: PUT,
        rate_limited: true,
        authentication: NoAccessToken,
        history: {
            unstable => "/_matrix/client/unstable/io.element.msc4388/rendezvous/{id}",
        }
    }

    /// Request type for the `PUT` `rendezvous` endpoint.
    #[request]
    pub struct Request {
        /// The ID of the rendezvous session to update.
        #[ruma_api(path)]
        pub id: String,

        /// The expected sequence token for the session. If it doesn't match the server state then
        /// an error is returned.
        pub sequence_token: String,

        /// Data up to maximum size allowed by the server.
        pub data: String,
    }

    impl Request {
        /// Creates a new `Request` with the given id, sequence token and data.
        pub fn new(id: String, sequence_token: String, data: String) -> Self {
            Self { id, sequence_token, data }
        }
    }

    /// Response type for the `PUT` `rendezvous` endpoint.
    #[response]
    #[derive(Default)]
    pub struct Response {
        /// The new sequence token for the session.
        pub sequence_token: String,
    }

    impl Response {
        /// Creates a new `Response` with the given sequence token.
        pub fn new(sequence_token: String) -> Self {
            Self { sequence_token }
        }
    }
}