ruma_appservice_api/query/
query_user_id.rs

1//! `GET /_matrix/app/*/users/{userId}`
2//!
3//! Endpoint to query the existence of a given user ID.
4
5pub mod v1 {
6    //! `/v1/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/application-service-api/#get_matrixappv1usersuserid
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata, OwnedUserId,
13    };
14
15    const METADATA: Metadata = metadata! {
16        method: GET,
17        rate_limited: false,
18        authentication: AccessToken,
19        history: {
20            1.0 => "/_matrix/app/v1/users/:user_id",
21        }
22    };
23
24    /// Request type for the `query_user_id` endpoint.
25    #[request]
26    pub struct Request {
27        /// The user ID being queried.
28        #[ruma_api(path)]
29        pub user_id: OwnedUserId,
30    }
31
32    /// Response type for the `query_user_id` endpoint.
33    #[response]
34    #[derive(Default)]
35    pub struct Response {}
36
37    impl Request {
38        /// Creates a new `Request` with the given user id.
39        pub fn new(user_id: OwnedUserId) -> Self {
40            Self { user_id }
41        }
42    }
43
44    impl Response {
45        /// Creates an empty `Response`.
46        pub fn new() -> Self {
47            Self {}
48        }
49    }
50}