char
/
matrix-rust-sdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add short explanation to Room::member_display_name.

master
Denis Kasak 2020-06-09 15:35:43 +02:00
parent 22ba253103
commit e6b67e5fa7
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
matrix_sdk_base/src/models/room.rs
View File

@ -303,6 +303,11 @@ impl Room {
} }
/// Get the disambiguated display name for a member of this room. /// Get the disambiguated display name for a member of this room.
///
/// When displaying a room member's display name, clients *must* use this method to obtain the
/// name instead of displaying the `RoomMember::display_name` directly. This is because
/// multiple users can share the same display name in which case the display name has to be
/// disambiguated.
pub fn member_display_name<'a>(&'a self, id: &UserId) -> Option<Cow<'a, str>> { pub fn member_display_name<'a>(&'a self, id: &UserId) -> Option<Cow<'a, str>> {
self.disambiguated_display_names self.disambiguated_display_names
.get(id) .get(id)