ruma_client_api/thirdparty/
get_user_for_user_id.rs

Help
1//! `GET /_matrix/client/*/thirdparty/user`
2//!
3//! Retrieve an array of third party users from a Matrix User ID.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3thirdpartyuser
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata,
13        thirdparty::User,
14        OwnedUserId,
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/user",
23            1.1 => "/_matrix/client/v3/thirdparty/user",
24        }
25    };
26
27    /// Request type for the `get_user_for_user_id` endpoint.
28    #[request(error = crate::Error)]
29    pub struct Request {
30        /// The Matrix User ID to look up.
31        #[ruma_api(query)]
32        pub userid: OwnedUserId,
33    }
34
35    /// Response type for the `get_user_for_user_id` endpoint.
36    #[response(error = crate::Error)]
37    pub struct Response {
38        /// List of matched third party users.
39        #[ruma_api(body)]
40        pub users: Vec<User>,
41    }
42
43    impl Request {
44        /// Creates a new `Request` with the given user ID.
45        pub fn new(userid: OwnedUserId) -> Self {
46            Self { userid }
47        }
48    }
49
50    impl Response {
51        /// Creates a new `Response` with the given users.
52        pub fn new(users: Vec<User>) -> Self {
53            Self { users }
54        }
55    }
56}
ruma_client_api/thirdparty/get_user_for_user_id.rs

ruma_client_api/thirdparty/
get_user_for_user_id.rs
