ruma_client_api/thirdparty/
get_protocols.rs

1//! `GET /_matrix/client/*/thirdparty/protocols`
2//!
3//! Fetches the overall metadata about protocols supported by the homeserver.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3thirdpartyprotocols
9
10    use std::collections::BTreeMap;
11
12    use ruma_common::{
13        api::{request, response, Metadata},
14        metadata,
15        thirdparty::Protocol,
16    };
17
18    const METADATA: Metadata = metadata! {
19        method: GET,
20        rate_limited: false,
21        authentication: AccessToken,
22        history: {
23            1.0 => "/_matrix/client/r0/thirdparty/protocols",
24            1.1 => "/_matrix/client/v3/thirdparty/protocols",
25        }
26    };
27
28    /// Request type for the `get_protocols` endpoint.
29    #[request(error = crate::Error)]
30    #[derive(Default)]
31    pub struct Request {}
32
33    /// Response type for the `get_protocols` endpoint.
34    #[response(error = crate::Error)]
35    pub struct Response {
36        /// Metadata about protocols supported by the homeserver.
37        #[ruma_api(body)]
38        pub protocols: BTreeMap<String, Protocol>,
39    }
40
41    impl Request {
42        /// Creates an empty `Request`.
43        pub fn new() -> Self {
44            Self {}
45        }
46    }
47
48    impl Response {
49        /// Creates a new `Response` with the given protocols.
50        pub fn new(protocols: BTreeMap<String, Protocol>) -> Self {
51            Self { protocols }
52        }
53    }
54}