ruma_client_api/
profile.rs

1//! Endpoints for user profiles.
2
3#[cfg(feature = "client")]
4use ruma_common::api::{
5    MatrixVersion,
6    path_builder::{StablePathSelector, VersionHistory},
7};
8#[cfg(feature = "unstable-msc4466")]
9use ruma_common::serde::StringEnum;
10
11#[cfg(feature = "unstable-msc4466")]
12use crate::PrivOwnedStr;
13
14pub mod delete_profile_field;
15pub mod get_avatar_url;
16pub mod get_display_name;
17pub mod get_profile;
18pub mod get_profile_field;
19#[cfg(feature = "client")]
20mod profile_field_serde;
21pub mod set_avatar_url;
22pub mod set_display_name;
23pub mod set_profile_field;
24
25pub use ruma_common::profile::*;
26
27/// Endpoint version history valid only for profile fields that didn't exist before Matrix 1.16.
28#[cfg(feature = "client")]
29const EXTENDED_PROFILE_FIELD_HISTORY: VersionHistory = VersionHistory::new(
30    &[(
31        Some("uk.tcpip.msc4133"),
32        "/_matrix/client/unstable/uk.tcpip.msc4133/profile/{user_id}/{field}",
33    )],
34    &[(
35        StablePathSelector::Version(MatrixVersion::V1_16),
36        "/_matrix/client/v3/profile/{user_id}/{field}",
37    )],
38    None,
39    None,
40);
41
42/// Whether the given field name existed already before custom fields were officially supported in
43/// profiles.
44#[cfg(feature = "client")]
45fn field_existed_before_extended_profiles(field_name: &ProfileFieldName) -> bool {
46    matches!(field_name, ProfileFieldName::AvatarUrl | ProfileFieldName::DisplayName)
47}
48
49/// Controls which rooms the server should send an updated `m.room.member` event in
50/// when changing `displayname` or `avatar_url` in a user's profile. Defined by [MSC4466][1].
51///
52/// [1]: https://github.com/matrix-org/matrix-spec-proposals/pull/4466
53#[cfg(feature = "unstable-msc4466")]
54#[doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/src/doc/string_enum.md"))]
55#[derive(Clone, Default, StringEnum)]
56#[ruma_enum(rename_all = "snake_case")]
57#[cfg_attr(not(ruma_unstable_exhaustive_types), non_exhaustive)]
58pub enum PropagateTo {
59    /// The server must send a `m.room.member` event in all of the user's
60    /// joined rooms.
61    #[default]
62    All,
63
64    /// The server must only send a `m.room.member` event in rooms where the profile
65    /// field being updated does _not_ differ from its value in the user's global profile data.
66    Unchanged,
67
68    /// The server must not send a `m.room.member` event to any rooms.
69    None,
70
71    #[doc(hidden)]
72    _Custom(PrivOwnedStr),
73}
ruma_client_api/profile.rs

ruma_client_api/
profile.rs
