AppLifecycleTriggerExecutor class

Runs an AppLifecycleTrigger: fires when the app enters a listed state.

The states are the trigger's AppLifecycleStates.

Inheritance
Mixed-in types

Properties

configuration → AppLifecycleTrigger?
The configuration of this executor as set in initialize.
no setterinherited
deployment → SmartphoneDeployment?
The deployment that this executor is part of executing.
no setterinherited
hashCode → int
The hash code for this object.
no setterinherited
measurements → Stream<Measurement>
The stream of Measurement collected by this executor.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
samplingState → SamplingState
The runtime sampling state of this executor.
no setterinherited
state → ExecutorState
The runtime state of this executor.
no setterinherited
stateEvents → Stream<ExecutorState>
The runtime state changes of this executor.
no setterinherited
timer ↔ Timer?
A timer for subclasses to use. Cancelled on pause and dispose.
getter/setter pairinherited
triggerEvents → Stream<TriggerEvent>
The stream of events triggered from this trigger executor.
no setterinherited

Methods

addError(Object error, [StackTrace? stacktrace]) → void
Logs error as a warning and adds it to the measurements stream.
inherited
addMeasurement(Measurement measurement) → void
Adds measurement to the measurements stream.
inherited
didChangeAccessibilityFeatures() → void
Called when the system changes the set of currently active accessibility features.
inherited
didChangeAppLifecycleState(AppLifecycleState state) → void
Called when the system puts the app in the background or returns the app to the foreground.
override
didChangeLocales(List<Locale>? locales) → void
Called when the system tells the app that the user's locale has changed. For example, if the user changes the system language settings.
inherited
didChangeMetrics() → void
Called when the application's dimensions change. For example, when a phone is rotated.
inherited
didChangePlatformBrightness() → void
Called when the platform brightness changes.
inherited
didChangeTextScaleFactor() → void
Called when the platform's text scale factor changes.
inherited
didChangeViewFocus(ViewFocusEvent event) → void
Called whenever the PlatformDispatcher receives a notification that the focus state on a view has changed.
inherited
didHaveMemoryPressure() → void
Called when the system is running low on memory.
inherited
didPopRoute() → Future<bool>
Called when the system tells the app to pop the current route, such as after a system back button press or back gesture.
inherited
didPushRoute(String route) → Future<bool>
Called when the host tells the application to push a new route onto the navigator.
inherited
didPushRouteInformation(RouteInformation routeInformation) → Future<bool>
Called when the host tells the application to push a new RouteInformation and a restoration state onto the router.
inherited
didRequestAppExit() → Future<AppExitResponse>
Called when a request is received from the system to exit the application.
inherited
dispose() → void
Disposes this executor.
inherited
error() → void
Moves this executor to ExecutorState.Undefined.
inherited
handleCancelBackGesture() → void
Called when a predictive back gesture is canceled, indicating that no navigation should occur.
inherited
handleCommitBackGesture() → void
Called when a predictive back gesture is finished successfully, indicating that the current route should be popped.
inherited
handleStartBackGesture(PredictiveBackEvent backEvent) → bool
Called at the start of a predictive back gesture.
inherited
handleStatusBarTap() → void
Called when the user taps the status bar on iOS, to scroll a scroll view to the top.
inherited
handleUpdateBackGestureProgress(PredictiveBackEvent backEvent) → void
Called when a predictive back gesture moves.
inherited
initialize(AppLifecycleTrigger configuration, [SmartphoneDeployment? deployment]) → void
Configures and initializes the executor. Call before resume.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onDispose() → Future<void>
Callback when this executor is disposed.
inherited
onInitialize() → bool
Called by initialize. Returns true if successfully initialized.
inherited
onPause() → Future<bool>
Called by pause. Returns true if successfully paused.
override
onResume() → Future<bool>
Called by resume. Returns true if successfully resumed.
override
onTrigger() → void
Fires this trigger by adding a TriggerEvent to triggerEvents.
inherited
pause() → void
Pauses the executor until resume is called.
inherited
pauseButShouldBeResumed() → void
Pauses the executor and marks it to be resumed later.
inherited
resume() → void
Starts or resumes the executor.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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