ruma_appservice_api/thirdparty/
get_location_for_protocol.rs

Help
1//! `GET /_matrix/app/*/thirdparty/location/{protocol}`
2//!
3//! Retrieve a list of Matrix portal rooms that lead to the matched third party location.
4
5pub mod v1 {
6    //! `/v1/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/application-service-api/#get_matrixappv1thirdpartylocationprotocol
9
10    use std::collections::BTreeMap;
11
12    use ruma_common::{
13        api::{request, response, Metadata},
14        metadata,
15        thirdparty::Location,
16    };
17
18    const METADATA: Metadata = metadata! {
19        method: GET,
20        rate_limited: false,
21        authentication: AccessToken,
22        history: {
23            1.0 => "/_matrix/app/v1/thirdparty/location/:protocol",
24        }
25    };
26
27    /// Request type for the `get_location_for_protocol` endpoint.
28    #[request]
29    pub struct Request {
30        /// The protocol used to communicate to the third party network.
31        #[ruma_api(path)]
32        pub protocol: String,
33
34        /// One or more custom fields to help identify the third party location.
35        #[ruma_api(query_all)]
36        pub fields: BTreeMap<String, String>,
37    }
38
39    /// Response type for the `get_location_for_protocol` endpoint.
40    #[response]
41    pub struct Response {
42        /// List of matched third party locations.
43        #[ruma_api(body)]
44        pub locations: Vec<Location>,
45    }
46
47    impl Request {
48        /// Creates a new `Request` with the given protocol.
49        pub fn new(protocol: String) -> Self {
50            Self { protocol, fields: BTreeMap::new() }
51        }
52    }
53
54    impl Response {
55        /// Creates a new `Response` with the given locations.
56        pub fn new(locations: Vec<Location>) -> Self {
57            Self { locations }
58        }
59    }
60}
ruma_appservice_api/thirdparty/get_location_for_protocol.rs

ruma_appservice_api/thirdparty/
get_location_for_protocol.rs
