ruma_client_api/profile/
set_display_name.rs

1//! `PUT /_matrix/client/*/profile/{userId}/displayname`
2//!
3//! Set the display name of the user.
4
5pub mod v3 {
6    //! `/v3/` ([spec])
7    //!
8    //! [spec]: https://spec.matrix.org/v1.15/client-server-api/#put_matrixclientv3profileuseriddisplayname
9
10    use ruma_common::{
11        api::{request, response},
12        metadata, OwnedUserId,
13    };
14
15    metadata! {
16        method: PUT,
17        rate_limited: true,
18        authentication: AccessToken,
19        history: {
20            1.0 => "/_matrix/client/r0/profile/{user_id}/displayname",
21            1.1 => "/_matrix/client/v3/profile/{user_id}/displayname",
22        }
23    }
24
25    /// Request type for the `set_display_name` endpoint.
26    #[request(error = crate::Error)]
27    pub struct Request {
28        /// The user whose display name will be set.
29        #[ruma_api(path)]
30        pub user_id: OwnedUserId,
31
32        /// The new display name for the user.
33        #[serde(skip_serializing_if = "Option::is_none")]
34        pub displayname: Option<String>,
35    }
36
37    /// Response type for the `set_display_name` endpoint.
38    #[response(error = crate::Error)]
39    #[derive(Default)]
40    pub struct Response {}
41
42    impl Request {
43        /// Creates a new `Request` with the given user ID and display name.
44        #[deprecated = "Use the set_profile_field endpoint instead."]
45        pub fn new(user_id: OwnedUserId, displayname: Option<String>) -> Self {
46            Self { user_id, displayname }
47        }
48    }
49
50    impl Response {
51        /// Creates an empty `Response`.
52        pub fn new() -> Self {
53            Self {}
54        }
55    }
56}
ruma_client_api/profile/set_display_name.rs

ruma_client_api/profile/
set_display_name.rs
