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
//! `GET /_matrix/client/*/profile/{userId}/displayname`
//!
//! Get the display name of a user.
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/latest/client-server-api/#get_matrixclientv3profileuseriddisplayname
use ruma_common::{
api::{request, response, Metadata},
metadata, OwnedUserId,
};
const METADATA: Metadata = metadata! {
method: GET,
rate_limited: false,
authentication: None,
history: {
1.0 => "/_matrix/client/r0/profile/:user_id/displayname",
1.1 => "/_matrix/client/v3/profile/:user_id/displayname",
}
};
/// Request type for the `get_display_name` endpoint.
#[request(error = crate::Error)]
pub struct Request {
/// The user whose display name will be retrieved.
#[ruma_api(path)]
pub user_id: OwnedUserId,
}
/// Response type for the `get_display_name` endpoint.
#[response(error = crate::Error)]
#[derive(Default)]
pub struct Response {
/// The user's display name, if set.
#[serde(skip_serializing_if = "Option::is_none")]
pub displayname: 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 display name.
pub fn new(displayname: Option<String>) -> Self {
Self { displayname }
}
}
}