AsyncField<T> class

An asynchronous field @ storage.

Available Extensions

Constructors

AsyncField(AsyncStorage storage, AsyncFieldID id)

Properties

canRefresh → bool
Returns true if a refresh can be performed.
no setter
defaultValue ↔ T?
getter/setter pair
deletedValue → T?
The last deleted value. See delete.
no setter
deleter ↔ AsyncFieldDeleter<T>?
getter/setter pair
dsxValueAllowAutoFetch ↔ bool
If true allows automatic fetch on toDSXValue. Default: true
getter/setter pair
dsxValueAllowSlate ↔ bool
If true allows slate values on toDSXValue. Default: false
getter/setter pair
fetcher ↔ AsyncFieldFetcher<T>?
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
hasPeriodicRefresh → bool
Returns true if this field value has periodicRefresh.
no setter
hasTimeout → bool
Returns true if this field value has timeout.
no setter
id → AsyncFieldID
The field ID in the storage.
final
idKey → Object
no setter
idKeyAsJson → Object
no setter
info → String
no setter
isClosed → bool
Returns true if storage.isClosed.
no setter
isExpire → bool
Returns true if this value is expired, based in the timeout.
no setter
isFetching → bool
no setter
isSet → bool
Returns true if this field value is set and NOT slate.
no setter
isSetOrSlate → bool
Returns true if this field value is set OR have a slate value.
no setter
isSlate → bool
Returns true if this field value has only a slate version.
no setter
isValid → bool
Returns true if this value is valid, based in the timeout and isSet.
no setter
onChange → Stream<AsyncField<T>>
On change value event.
no setter
onChangeFilter ↔ (bool Function(T? prevValue, T? value)?)
Filters values changes before trigger onChange.
getter/setter pair
onDelete → Stream<AsyncField<T>>
no setter
onDispose → Stream<AsyncField<T>>
no setter
onFetch → Stream<AsyncField<T>>
no setter
onSave → Stream<AsyncField<T>>
no setter
periodicRefresh ↔ Duration?
Refresh period. After set a value, it will refresh the value periodically.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
saver ↔ AsyncFieldSaver<T>?
getter/setter pair
storage → AsyncStorage
The field storage.
final
timeout ↔ Duration?
The values timeout.
getter/setter pair
value → T?
Returns the current field value.
no setter
valueAsBool → bool
no setter
valueAsDouble → double
no setter
valueAsInt → int
no setter
valueAsJson → String
no setter
valueAsString → String
no setter
valueElapsedTime → int
Returns the amount of time from the last value set or fetch.
no setter
valueNoTimeoutCheck → T?
Returns value without checkValueTimeout.
no setter
valueOrSlate → T?
Returns value or a slate version or the defaultValue.
no setter
valueOrSlateNoTimeoutCheck → T?
Returns valueOrSlate without checkValueTimeout.
no setter
valueTime → DateTime?
Returns the value time, when it was set.
no setter
valueTimeMillisecondsSinceEpoch → int?
Same as valueTime, but millisecondsSinceEpoch.
no setter
valueTimeUntilExpire → int
Returns the amount of time until the current value is expired (in ms).
no setter

Methods

checkValueTimeout() → T?
Checks value timeout and invalidate it if isExpire.
delete() → FutureOr<bool>
Deletes this field value from storage, but won't dispose it. See deletedValue.
dispose() → FutureOr<bool>
Disposes this field. Will remove it from storage, but won't delete its value.
disposeDeletedValue() → void
disposeValue() → T?
Discard the current value.
get({void onSlateValue(T slate)?}) → FutureOr<T>
Returns the current value of the field.
getAsBool() → FutureOr<bool>
get as bool.
getAsDouble() → FutureOr<double>
get as double.
getAsInt() → FutureOr<int>
get as int.
getAsJson() → FutureOr<String>
get as JSON.
getAsString() → FutureOr<String>
get as String.
listenDSXValue(void onData(AsyncField<T> field)?) → StreamSubscription<AsyncField<T>>
DSX dynamic interface (package dom_builder).
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
refresh() → FutureOr<T>
Refreshes this field and returns the fresh value.
save() → FutureOr<T>
Saves this field value and returns the saved value.
set(T value) → FutureOr<T>
Sets this field with value.
toDSXValue() → dynamic
DSX dynamic interface (package dom_builder).
toString() → String
Same as valueAsString.
override
withDeleter(AsyncFieldDeleter<T>? deleter, {bool overwrite = false}) → AsyncField<T>
Defines the deleter of this field.
withFetcher(AsyncFieldFetcher<T>? fetcher, {bool overwrite = false}) → AsyncField<T>
Defines the fetcher of this field.
withSaver(AsyncFieldSaver<T>? saver, {bool overwrite = false}) → AsyncField<T>
Defines the saver of this field.

Operators

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