ruma_client_api/thirdparty/
get_user_for_protocol.rs

Help
1//! `GET /_matrix/client/*/thirdparty/user/{protocol}`
2//!
3//! Fetches third party users for a protocol.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3thirdpartyuserprotocol
9
10    use std::collections::BTreeMap;
11
12    use ruma_common::{
13        api::{request, response, Metadata},
14        metadata,
15        thirdparty::User,
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/user/:protocol",
24            1.1 => "/_matrix/client/v3/thirdparty/user/:protocol",
25        }
26    };
27
28    /// Request type for the `get_user_for_protocol` endpoint.
29    #[request(error = crate::Error)]
30    pub struct Request {
31        /// The protocol used to communicate to the third party network.
32        #[ruma_api(path)]
33        pub protocol: String,
34
35        /// One or more custom fields that are passed to the AS to help identify the user.
36        #[ruma_api(query_all)]
37        pub fields: BTreeMap<String, String>,
38    }
39
40    /// Response type for the `get_user_for_protocol` endpoint.
41    #[response(error = crate::Error)]
42    pub struct Response {
43        /// List of matched third party users.
44        #[ruma_api(body)]
45        pub users: Vec<User>,
46    }
47
48    impl Request {
49        /// Creates a new `Request` with the given protocol.
50        pub fn new(protocol: String) -> Self {
51            Self { protocol, fields: BTreeMap::new() }
52        }
53    }
54
55    impl Response {
56        /// Creates a new `Response` with the given users.
57        pub fn new(users: Vec<User>) -> Self {
58            Self { users }
59        }
60    }
61}
ruma_client_api/thirdparty/get_user_for_protocol.rs

ruma_client_api/thirdparty/
get_user_for_protocol.rs
