UserProvider class
Provides the currently logged in User. The user is inferred from the UserToken provided by userTokenProvider and will be updated automatically as changes occur.
Note: If the user is not logged in, this provider will return null.
- Inheritance
-
- Object
- StateNotifier<
User?> - AutoRefreshStateNotifier<
User?> - UserProvider
Constructors
- UserProvider(UserDataSource userDataSource)
- Provides the currently logged in User. The user is inferred from the UserToken provided by userTokenProvider and will be updated automatically as changes occur.
Properties
- debugState → 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 ↔ User?
-
The current "state" of this StateNotifier.
read / writeinherited
-
stream
→ Stream<
User?> -
A broadcast stream representation of a StateNotifier.
read-onlyinherited
- userDataSource → UserDataSource
-
The data source to use.
final
Methods
-
addListener(
Listener< User?> listener, {bool fireImmediately = true}) → RemoveListener -
Subscribes to this object.
inherited
-
deleteUser(
) → Future< void> - Deletes the current user.
-
dispose(
) → void -
Frees all the resources associated with this object.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onRefresh(
) → FutureOr< User?> -
Returns the new state.
override
-
toString(
) → String -
A string representation of this object.
inherited
-
updateShouldNotify(
User? old, User? current) → bool -
Whether to notify listeners or not when state changes
inherited
-
updateUser(
User user) → Future< void> -
Updates the current user with the given
userdata.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited