Skip to content

Commit a1246ee

Browse files
gnpricechrisbobbe
authored andcommitted
user [nfc]: Document explicitly that allUsers includes deactivated
Potentially this would have helped us avoid the issue #1743.
1 parent ff335a6 commit a1246ee

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

lib/model/user.dart

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,10 @@ mixin UserStore on PerAccountStoreBase, RealmStore {
3535
/// Consider using [userDisplayName].
3636
User? getUser(int userId);
3737

38-
/// All known users in the realm.
38+
/// All known users in the realm, including deactivated users.
39+
///
40+
/// Before presenting these users in the UI, consider whether to exclude
41+
/// users who are deactivated (see [User.isActive]) or muted ([isUserMuted]).
3942
///
4043
/// This may have a large number of elements, like tens of thousands.
4144
/// Consider [getUser] or other alternatives to iterating through this.

0 commit comments

Comments
 (0)