ruma_client_api/thirdparty/
get_protocol.rs

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

ruma_client_api/thirdparty/
get_protocol.rs
