1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
//! `GET /_matrix/client/*/profile/{userId}/avatar_url`
//!
//! Get the avatar URL of a user.
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/v1.15/client-server-api/#get_matrixclientv3profileuseridavatar_url
use ruma_common::{
OwnedMxcUri, OwnedUserId,
api::{auth_scheme::NoAuthentication, request, response},
metadata,
};
metadata! {
method: GET,
rate_limited: false,
authentication: NoAuthentication,
history: {
1.0 => "/_matrix/client/r0/profile/{user_id}/avatar_url",
1.1 => "/_matrix/client/v3/profile/{user_id}/avatar_url",
}
}
/// Request type for the `get_avatar_url` endpoint.
#[request(error = crate::Error)]
pub struct Request {
/// The user whose avatar URL will be retrieved.
#[ruma_api(path)]
pub user_id: OwnedUserId,
}
/// Response type for the `get_avatar_url` endpoint.
#[response(error = crate::Error)]
#[derive(Default)]
pub struct Response {
/// The user's avatar URL, if set.
///
/// If you activate the `compat-empty-string-null` feature, this field being an empty
/// string in JSON will result in `None` here during deserialization.
#[serde(skip_serializing_if = "Option::is_none")]
#[cfg_attr(
feature = "compat-empty-string-null",
serde(default, deserialize_with = "ruma_common::serde::empty_string_as_none")
)]
pub avatar_url: Option<OwnedMxcUri>,
/// The [BlurHash](https://blurha.sh) for the avatar pointed to by `avatar_url`.
///
/// This uses the unstable prefix in
/// [MSC2448](https://github.com/matrix-org/matrix-spec-proposals/pull/2448).
#[cfg(feature = "unstable-msc2448")]
#[serde(rename = "xyz.amorgan.blurhash", skip_serializing_if = "Option::is_none")]
pub blurhash: Option<String>,
}
impl Request {
/// Creates a new `Request` with the given user ID.
#[deprecated = "Use the get_profile_field endpoint instead."]
pub fn new(user_id: OwnedUserId) -> Self {
Self { user_id }
}
}
impl Response {
/// Creates a new `Response` with the given avatar URL.
pub fn new(avatar_url: Option<OwnedMxcUri>) -> Self {
Self {
avatar_url,
#[cfg(feature = "unstable-msc2448")]
blurhash: None,
}
}
}
}