AFPeriodicQuery class abstract
A version of AFAsyncQuery for queries that should be run periodically in the background.
- Inheritance
-
- Object
- AFObjectWithKey
- AFActionWithKey
- AFAsyncQuery<
AFUnused> - AFPeriodicQuery
- Implemented types
Constructors
-
AFPeriodicQuery(Duration delay, {bool executeImmediately = false, AFID? id, AFOnResponseDelegate<
AFUnused> ? onSuccess, bool keepGoing = true})
Properties
- conceptualStore ↔ AFConceptualStore
-
getter/setter pairinherited
- delay → Duration
-
final
- executeImmediately → bool
-
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- id → AFID?
-
finalinherited
- keepGoing ↔ bool
-
getter/setter pair
- key → String
-
no setterinherited
- lastStart ↔ int?
-
getter/setter pairinherited
- onError → AFOnErrorDelegate?
-
finalinherited
-
onPreExecuteResponse
→ AFPreExecuteResponseDelegate<
AFUnused> ? -
finalinherited
-
onSuccess
→ AFOnResponseDelegate<
AFUnused> ? -
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- simulatedLatencyFactor → int?
-
finalinherited
- timer ↔ Timer?
-
getter/setter pair
Methods
-
afShutdown(
) → void -
createSuccessContext(
{required AFDispatcher dispatcher, required AFState state, required bool isPreExecute}) → AFFinishQuerySuccessContext< AFUnused> -
createSuccessContextForResponse(
{required AFDispatcher dispatcher, required AFState state, required AFUnused response, required bool isPreExecute}) → AFFinishQuerySuccessContext< AFUnused> -
inherited
-
currentMillis(
) → int -
inherited
-
finishAsyncExecute(
AFFinishQuerySuccessContext< AFUnused> context) → bool -
finishAsyncWithError(
AFFinishQueryErrorContext context) → void -
The default implementation calls the error handler specified
in your xxx_define_core.dart file.
inherited
-
finishAsyncWithErrorAF(
AFFinishQueryErrorContext context) → void -
inherited
-
finishAsyncWithResponse(
AFFinishQuerySuccessContext< AFUnused> context) → void -
Calls the more appropriate finishAsyncExecute when the delay associated with this
query has expired.
override
-
finishAsyncWithResponseAF(
AFFinishQuerySuccessContext< AFUnused> context) → void -
Called internally by the framework to do pre and post processing before finishAsyncWithResponse
inherited
-
mergeOnWrite(
AFTrackedQuery newQuery) → AFTrackedQuery? -
Returns the new query, causing any existing query to be shutdown and replaced with the new one
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
retargetStore(
AFConceptualStore target) → void -
inherited
-
shutdown(
) → void -
Called when this query terminates.
override
-
startAsync(
AFStartQueryContext< AFUnused> context) → void -
Delays for delay and then calls finishAsyncWithResponse with null as the value.
override
-
startAsyncAF(
AFDispatcher dispatcher, AFStore store, {required Completer< AFFinishQuerySuccessContext> ? completer, void onResponseExtra(dynamic)?, void onErrorExtra(dynamic)?}) → void -
Called internally when redux middleware begins processing a query.
inherited
-
testFinishAsyncWithError(
AFStateTestContext context, AFQueryError error) → void -
Called during testing to simulate results from an asynchronous call.
inherited
-
testFinishAsyncWithResponse(
AFStateTestContext context, AFUnused response) → void -
Called during testing to simulate results from an asynchronous call.
inherited
-
throwUnimplemented(
) → Never -
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited