BackgroundDriftProvider class - background library

Constructors

BackgroundDriftProvider(CommonDriftProvider database)

Properties

db → CommonDatabase?: Returns the CommonDatabase.
no setterinherited
hashCode → int: The hash code for this object.
no setterinherited
initialized → bool: Checks whether the controller has already been initialized.
no setterinherited
isClosed → bool: Checks whether the controller has already been closed.
no setterinherited
onDelete → InternalFinalCallback<void>: Internal callback that starts the cycle of this controller.
finalinherited
onStart → InternalFinalCallback<void>: Called at the exact moment the widget is allocated in memory. It uses an internal "callable" type, to avoid any @overrides in subclases. This method should be internal and is required to define the lifetime cycle of the subclass.
finalinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

$configureLifeCycle() → void: inherited
clear() → Future<void>: Deletes all the DtoBackgrounds stored in the database.
delete(UserId id) → Future<void>: Deletes the DtoBackground identified by the provided id from the database.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
onClose() → void: Called before onDelete method. onClose might be used to dispose resources used by the controller. Like closing events, or streams before the controller is destroyed. Or dispose objects that can potentially create some memory leaks, like TextEditingControllers, AnimationControllers. Might be useful as well to persist some data on disk.
inherited
onInit() → void: Called immediately after the widget is allocated in memory. You might use this to initialize something for the controller.
inherited
onReady() → void: Called 1 frame after onInit(). It is the perfect place to enter navigation events, like snackbar, dialogs, or a new route, or async request.
inherited
read(UserId id) → Future<DtoBackground?>: Returns the DtoBackground stored in the database by the provided id, if any.
safe<T>(Future<T> callback(CommonDatabase db), {bool exclusive = true, String? tag}) → Future<T?>: Runs the callback through a non-closed CommonDatabase, or returns null.
inherited
stream<T>(Stream<T> executor(CommonDatabase db)) → Stream<T>: Listens to the executor through a non-closed CommonDatabase.
inherited
toString() → String: A string representation of this object.
inherited
txn<T>(Future<T> action()) → Future<void>: Completes the provided action as a db transaction.
inherited
upsert(UserId userId, DtoBackground background) → Future<DtoBackground>: Creates or updates the provided background in the database.
watch(UserId id) → Stream<DtoBackground?>: Returns the Stream of real-time changes happening with the DtoBackground identified by the provided id.

Operators

operator ==(Object other) → bool: The equality operator.
inherited