ruma_federation_api/query/
get_profile_information.rs

Help
1//! `GET /_matrix/federation/*/query/profile`
2//!
3//! Get profile information, such as a display name or avatar, for a given user.
4
5pub mod v1 {
6    //! `/v1/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/latest/server-server-api/#get_matrixfederationv1queryprofile
9
10    use ruma_common::{
11        api::{request, response, Metadata},
12        metadata,
13        serde::StringEnum,
14        OwnedMxcUri, OwnedUserId,
15    };
16
17    use crate::PrivOwnedStr;
18
19    const METADATA: Metadata = metadata! {
20        method: GET,
21        rate_limited: false,
22        authentication: ServerSignatures,
23        history: {
24            1.0 => "/_matrix/federation/v1/query/profile",
25        }
26    };
27
28    /// Request type for the `get_profile_information` endpoint.
29    #[request]
30    pub struct Request {
31        /// User ID to query.
32        #[ruma_api(query)]
33        pub user_id: OwnedUserId,
34
35        /// Profile field to query.
36        #[serde(skip_serializing_if = "Option::is_none")]
37        #[ruma_api(query)]
38        pub field: Option<ProfileField>,
39    }
40
41    /// Response type for the `get_profile_information` endpoint.
42    #[response]
43    #[derive(Default)]
44    pub struct Response {
45        /// Display name of the user.
46        #[serde(skip_serializing_if = "Option::is_none")]
47        pub displayname: Option<String>,
48
49        /// Avatar URL for the user's avatar.
50        ///
51        /// If you activate the `compat-empty-string-null` feature, this field being an empty
52        /// string in JSON will result in `None` here during deserialization.
53        #[serde(skip_serializing_if = "Option::is_none")]
54        #[cfg_attr(
55            feature = "compat-empty-string-null",
56            serde(default, deserialize_with = "ruma_common::serde::empty_string_as_none")
57        )]
58        pub avatar_url: Option<OwnedMxcUri>,
59
60        /// The [BlurHash](https://blurha.sh) for the avatar pointed to by `avatar_url`.
61        ///
62        /// This uses the unstable prefix in
63        /// [MSC2448](https://github.com/matrix-org/matrix-spec-proposals/pull/2448).
64        #[cfg(feature = "unstable-msc2448")]
65        #[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
66        pub blurhash: Option<String>,
67    }
68
69    impl Request {
70        /// Creates a new `Request` with the given user id.
71        pub fn new(user_id: OwnedUserId) -> Self {
72            Self { user_id, field: None }
73        }
74    }
75
76    impl Response {
77        /// Creates an empty `Response`.
78        pub fn new() -> Self {
79            Default::default()
80        }
81    }
82
83    /// Profile fields to specify in query.
84    ///
85    /// This type can hold an arbitrary string. To build this with a custom value, convert it from a
86    /// string with `::from()` / `.into()`. To check for values that are not available as a
87    /// documented variant here, use its string representation, obtained through
88    /// [`.as_str()`](Self::as_str()).
89    #[derive(Clone, PartialEq, Eq, StringEnum)]
90    #[non_exhaustive]
91    pub enum ProfileField {
92        /// Display name of the user.
93        #[ruma_enum(rename = "displayname")]
94        DisplayName,
95
96        /// Avatar URL for the user's avatar.
97        #[ruma_enum(rename = "avatar_url")]
98        AvatarUrl,
99
100        #[doc(hidden)]
101        _Custom(PrivOwnedStr),
102    }
103}
ruma_federation_api/query/get_profile_information.rs

ruma_federation_api/query/
get_profile_information.rs
