LifecycleController class abstract

A controller with full app lifecycle observation capabilities.

Inheritance
Mixed-in types
Implementers

Constructors

LifecycleController.new()

Properties

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
isDisposed bool
Checks if the notifier has been disposed.
no setterinherited
listenersLength int
Returns the number of active listeners.
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

addListener(GetStateUpdate listener) Disposer
Adds a listener and returns a Disposer to remove it later.
inherited
addListenerId(Object? key, GetStateUpdate listener) Disposer
Adds a listener to a specific group ID.
inherited
containsId(Object id) bool
Checks if a specific ID exists in the group.
inherited
containsListener(GetStateUpdate listener) bool
Checks if a given listener is already registered.
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.
inherited
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 all listeners in the group.
inherited
disposeId(Object id) → void
Disposes of a specific ID from future updates.
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
handleUpdateBackGestureProgress(PredictiveBackEvent backEvent) → void
Called when a predictive back gesture moves.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyGroupChildren(Object id) → void
Notifies all children of a given group ID.
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.
override
onDelete() → void
Called when the controller is removed from memory.
inherited
onDetached() → void
Called when the app is detached.
inherited
onHidden() → void
Called when the app is hidden.
inherited
onInactive() → void
Called when the app is in an inactive state.
inherited
onInit() → void
Called immediately after the widget is allocated in memory. You might use this to initialize something for the controller.
override
onPaused() → void
Called when the app is paused.
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
onResumed() → void
Called when the app is resumed from a paused state.
inherited
onStart() → void
Called at the exact moment the widget is allocated in memory. It uses an internal "callable" type, to avoid any @overrides in subclasses. This method should be internal and is required to define the lifetime cycle of the subclass.
inherited
refresh() → void
Notifies all registered listeners of an update.
inherited
refreshGroup(Object id) → void
Refreshes all listeners associated with a specific ID.
inherited
registerLifecycleObserver() → void
Registers this mixin as an app lifecycle observer.
inherited
removeListener(VoidCallback listener) → void
Removes a registered listener.
inherited
removeListenerId(Object id, VoidCallback listener) → void
Removes a specific listener from a group by ID.
inherited
reportAdd(VoidCallback disposer) → void
Reports a new listener addition.
inherited
reportRead() → void
Reports that a read operation has occurred.
inherited
toString() String
A string representation of this object.
inherited
unregisterLifecycleObserver() → void
Unregisters this mixin as an app lifecycle observer.
inherited
update([List<Object>? ids, bool condition = true]) → void
Rebuilds the associated widgets.
inherited

Operators

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