ruma_client_api/thirdparty/
get_location_for_room_alias.rs

Help
1//! `GET /_matrix/client/*/thirdparty/location`
2//!
3//! Retrieve an array of third party network locations from a Matrix room alias.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3thirdpartylocation
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata,
13        thirdparty::Location,
14        OwnedRoomAliasId,
15    };
16
17    const METADATA: Metadata = metadata! {
18        method: GET,
19        rate_limited: false,
20        authentication: AccessToken,
21        history: {
22            1.0 => "/_matrix/client/r0/thirdparty/location",
23            1.1 => "/_matrix/client/v3/thirdparty/location",
24        }
25    };
26
27    /// Request type for the `get_location_for_room_alias` endpoint.
28    #[request(error = crate::Error)]
29    pub struct Request {
30        /// The Matrix room alias to look up.
31        #[ruma_api(query)]
32        pub alias: OwnedRoomAliasId,
33    }
34
35    /// Response type for the `get_location_for_room_alias` endpoint.
36    #[response(error = crate::Error)]
37    pub struct Response {
38        /// List of matched third party locations.
39        #[ruma_api(body)]
40        pub locations: Vec<Location>,
41    }
42
43    impl Request {
44        /// Creates a new `Request` with the given room alias ID.
45        pub fn new(alias: OwnedRoomAliasId) -> Self {
46            Self { alias }
47        }
48    }
49
50    impl Response {
51        /// Creates a new `Response` with the given locations.
52        pub fn new(locations: Vec<Location>) -> Self {
53            Self { locations }
54        }
55    }
56}
ruma_client_api/thirdparty/get_location_for_room_alias.rs

ruma_client_api/thirdparty/
get_location_for_room_alias.rs
