Skip to content

Commit 43f3e10

Browse files
authored
Improve documentation on rawDisplayName (#5114)
... since it's not actually the raw displayname, at all.
1 parent 97fcdb2 commit 43f3e10

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

src/models/room-member.ts

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,16 +94,23 @@ export class RoomMember extends TypedEventEmitter<RoomMemberEvent, RoomMemberEve
9494
* True if the room member is currently typing.
9595
*/
9696
public typing = false;
97+
9798
/**
98-
* The human-readable name for this room member. This will be
99+
* The human-readable name for this room member. Similar to {@link rawDisplayName}, but
99100
* disambiguated with a suffix of " (\@user_id:matrix.org)" if another member shares the
100101
* same displayname.
101102
*/
102103
public name: string;
104+
103105
/**
104-
* The ambiguous displayname of this room member.
106+
* The ambiguous displayname of this room member, with some preprocessing:
107+
*
108+
* * Direction override characters (RTO and LRO) are removed.
109+
* * If the displayname is empty, or contains only blank, non-printing, or diacritcic characters, it is
110+
* replaced with the user ID.
105111
*/
106112
public rawDisplayName: string;
113+
107114
/**
108115
* The power level for this room member.
109116
*/

0 commit comments

Comments
 (0)