75 lines
2.4 KiB
Rust
75 lines
2.4 KiB
Rust
//! `GET /_matrix/client/*/profile/{userId}/avatar_url`
|
|
//!
|
|
//! Get the avatar URL of a user.
|
|
|
|
pub mod v3 {
|
|
//! `/v3/` ([spec])
|
|
//!
|
|
//! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3profileuseridavatar_url
|
|
|
|
use ruma_common::{
|
|
api::{request, response, Metadata},
|
|
metadata, OwnedMxcUri, OwnedUserId,
|
|
};
|
|
|
|
const METADATA: Metadata = metadata! {
|
|
method: GET,
|
|
rate_limited: false,
|
|
authentication: None,
|
|
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` 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",
|
|
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.
|
|
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,
|
|
}
|
|
}
|
|
}
|
|
}
|