PersistedStoreProvider<S> class

A Store<S> that saves its state to a persistence layer on a regular base and restores it at launch.

If no state has been saved yet, the initialState is used.

While restoring, the restoringBuilder is used to build its child, and once restored the restoredbuilder is used.

The saves are debounced with the debouncing period.

A storeInitializer can be used to customize the store once loaded.

Inheritance

Constructors

PersistedStoreProvider({Key key, @required Create<Store<S>> initialStore, @required Persistence<S> persistence, @required WidgetBuilder restoredbuilder, @required WidgetBuilder restoringBuilder, Duration debouncing = const Duration(milliseconds: 500), PersistedStoreInitializer<S> storeInitializer})
Creates a StoreProvider instance and exposes both the Store and its Store.state using provider. [...]
const

Properties

debouncing Duration
final
hashCode int
The hash code for this object. [...]
@nonVirtual, read-only, inherited
initialStore Create<Store<S>>
final
key Key
Controls how one widget replaces another widget in the tree. [...]
final, inherited
persistence Persistence<S>
final
restoredbuilder WidgetBuilder
final
restoringBuilder WidgetBuilder
final
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
storeInitializer PersistedStoreInitializer<S>
final

Methods

createElement() StatefulElement
Creates a StatefulElement to manage this widget's location in the tree. [...]
inherited
createState() → _PersistedStoreProviderState<S>
Creates the mutable state for this widget at a given location in the tree. [...]
override
debugDescribeChildren() List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children. [...]
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toDiagnosticsNode({String name, DiagnosticsTreeStyle style}) DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep. [...]
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) String
A string representation of this object. [...]
inherited
toStringDeep({String prefixLineOne = '', String prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a string representation of this node and its descendants. [...]
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) String
Returns a one-line detailed description of the object. [...]
inherited
toStringShort() String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
@nonVirtual, inherited