Skip to main content

Module profile

Module profile 

Source
Available on crate features client or server only.
Expand description

Endpoints for user profiles.

Modules§

delete_profile_field
DELETE /_matrix/client/*/profile/{userId}/{key_name}
get_avatar_url
GET /_matrix/client/*/profile/{userId}/avatar_url
get_display_name
GET /_matrix/client/*/profile/{userId}/displayname
get_profile
GET /_matrix/client/*/profile/{userId}
get_profile_field
GET /_matrix/client/*/profile/{userId}/{key_name}
set_avatar_url
PUT /_matrix/client/*/profile/{userId}/avatar_url
set_display_name
PUT /_matrix/client/*/profile/{userId}/displayname
set_profile_field
PUT /_matrix/client/*/profile/{userId}/{key_name}

Structs§

AvatarUrl
The user’s avatar URL.
Callunstable-msc4426
The user’s call indicator.
CallProfileFieldunstable-msc4426
An indicator that the user is currently in a call, and optionally how long they’ve been in the call.
DisplayName
The user’s display name.
ProfileFieldValueVisitor
Helper type to deserialize ProfileFieldValue.
Statusunstable-msc4426
The user’s current status.
StatusProfileFieldunstable-msc4426
A text-only field describing the user’s current state, along with an emoji.
TimeZone
The user’s time zone.
UserProfile
All the profile information for a user.

Enums§

ProfileFieldName
The possible fields of a user’s profile.
ProfileFieldValue
The possible values of a field of a user’s profile.
PropagateTounstable-msc4466
Controls which rooms the server should send an updated m.room.member event in when changing displayname or avatar_url in a user’s profile. Defined by MSC4466.

Traits§

StaticProfileField
Trait implemented by types representing a field in a user’s profile having a statically-known name.