ruma_identity_service_api/association/
check_3pid_validity.rs

Help
1//! `GET /_matrix/identity/*/3pid/getValidated3pid`
2//!
3//! Determine if a given 3PID has been validated by a user.
4
5pub mod v2 {
6    //! `/v2/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/identity-service-api/#get_matrixidentityv23pidgetvalidated3pid
9
10    use js_int::UInt;
11    use ruma_common::{
12        api::{request, response, Metadata},
13        metadata,
14        thirdparty::Medium,
15        OwnedClientSecret, OwnedSessionId,
16    };
17
18    const METADATA: Metadata = metadata! {
19        method: GET,
20        rate_limited: false,
21        authentication: AccessToken,
22        history: {
23            1.0 => "/_matrix/identity/v2/3pid/getValidated3pid/",
24        }
25    };
26
27    /// Request type for the `check_3pid_validity` endpoint.
28    #[request]
29    pub struct Request {
30        /// The Session ID generated by the `requestToken` call.
31        #[ruma_api(query)]
32        pub sid: OwnedSessionId,
33
34        /// The client secret passed to the `requestToken` call.
35        #[ruma_api(query)]
36        pub client_secret: OwnedClientSecret,
37    }
38
39    /// Response type for the `check_3pid_validity` endpoint.
40    #[response]
41    pub struct Response {
42        /// The medium type of the 3PID.
43        pub medium: Medium,
44
45        /// The address of the 3PID being looked up.
46        pub address: String,
47
48        /// Timestamp, in milliseconds, indicating the time that the 3PID was validated.
49        pub validated_at: UInt,
50    }
51
52    impl Request {
53        /// Creates a `Request` with the given Session ID and client secret.
54        pub fn new(sid: OwnedSessionId, client_secret: OwnedClientSecret) -> Self {
55            Self { sid, client_secret }
56        }
57    }
58
59    impl Response {
60        /// Creates a `Response` with the given medium, address and validation timestamp.
61        pub fn new(medium: Medium, address: String, validated_at: UInt) -> Self {
62            Self { medium, address, validated_at }
63        }
64    }
65}
ruma_identity_service_api/association/check_3pid_validity.rs

ruma_identity_service_api/association/
check_3pid_validity.rs
