UsersProvider class
Provides a list of all users.
Note: Unless the current user has UserCapability.dev or UserCapability.moderator, some information about other users will be redacted:
- User.themeName
- User.language
- User.capabilitiesBitMask
- User.capabilities
- User.locale
- User.planId
- User.colorBlindness
- User.colorBlindnessString
- User.displayTaskCount
- User.displayTaskCountInt
Additionally provides methods for querying users.
- Inheritance
-
- Object
- StateNotifier<
List< User> > - AutoRefreshStateNotifier<
List< User> > - UsersProvider
Constructors
- UsersProvider(UserDataSource userDataSource)
- Provides a list of all users.
Properties
-
debugState
→ List<
User> -
A development-only way to access state outside of StateNotifier.
read-onlyinherited
- hashCode → int
-
The hash code for this object.
read-onlyinherited
- hasListeners → bool
-
If a listener has been added using addListener and hasn't been removed yet.
read-onlyinherited
- mounted → bool
-
Whether dispose was called or not.
read-onlyinherited
- onError ↔ ErrorListener?
-
A callback for error reporting if one of the listeners added with addListener throws.
read / writeinherited
- refreshRate → Duration
-
The refresh rate of the data.
read-onlyinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
-
state
↔ List<
User> -
The current "state" of this StateNotifier.
read / writeinherited
-
stream
→ Stream<
List< User> > -
A broadcast stream representation of a StateNotifier.
read-onlyinherited
- userDataSource → UserDataSource
-
The data source to use.
final
Methods
-
addListener(
Listener< List< listener, {bool fireImmediately = true}) → RemoveListenerUser> > -
Subscribes to this object.
inherited
-
dispose(
) → void -
Frees all the resources associated with this object.
inherited
-
filterBy(
{String? username, String? firstname, String? lastname, String? vintage, List< UserCapability> ? capabilities}) → List<User> - Filters the users by the given parameters.
-
findUserById(
int id) → User? -
Returns the user with the given
id. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onRefresh(
) → FutureOr< List< User> > -
Returns the new state.
override
-
searchUsers(
String query) → List< User> -
Searches for users with the given
query. -
toString(
) → String -
A string representation of this object.
inherited
-
updateShouldNotify(
List< User> old, List<User> current) → bool -
Whether to notify listeners or not when state changes
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited