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
//! `PUT /_matrix/client/*/profile/{userId}/displayname`
//!
//! Set the display name of the user.
pub mod v3 {
//! `/v3/` ([spec])
//!
//! [spec]: https://spec.matrix.org/v1.15/client-server-api/#put_matrixclientv3profileuseriddisplayname
use ruma_common::{
OwnedUserId,
api::{auth_scheme::AccessToken, request, response},
metadata,
};
metadata! {
method: PUT,
rate_limited: true,
authentication: AccessToken,
history: {
1.0 => "/_matrix/client/r0/profile/{user_id}/displayname",
1.1 => "/_matrix/client/v3/profile/{user_id}/displayname",
}
}
/// Request type for the `set_display_name` endpoint.
#[request(error = crate::Error)]
pub struct Request {
/// The user whose display name will be set.
#[ruma_api(path)]
pub user_id: OwnedUserId,
/// The new display name for the user.
#[serde(skip_serializing_if = "Option::is_none")]
pub displayname: Option<String>,
}
/// Response type for the `set_display_name` endpoint.
#[response(error = crate::Error)]
#[derive(Default)]
pub struct Response {}
impl Request {
/// Creates a new `Request` with the given user ID and display name.
#[deprecated = "Use the set_profile_field endpoint instead."]
pub fn new(user_id: OwnedUserId, displayname: Option<String>) -> Self {
Self { user_id, displayname }
}
}
impl Response {
/// Creates an empty `Response`.
pub fn new() -> Self {
Self {}
}
}
}