GoRouteInformationProvider class - go_router library

Constructors

GoRouteInformationProvider({required String initialLocation, required Object? initialExtra, Listenable? refreshListenable}): Creates a GoRouteInformationProvider.

Properties

hashCode → int: The hash code for this object.
no setterinherited
hasListeners → bool: Whether any listeners are currently registered.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
value → RouteInformation: The current value of the object. When the value changes, the callbacks registered with addListener will be invoked.
no setteroverride

Methods

addListener(VoidCallback listener) → void: Register a closure to be called when the object notifies its listeners.
override
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
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.
override
didRequestAppExit() → Future<AppExitResponse>: Called when a request is received from the system to exit the application.
inherited
dispose() → void: Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).
override
go(String location, {Object? extra}) → void: Replace the current route matches with the location.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void: Call all the registered listeners.
override
push<T>(String location, {required RouteMatchList base, Object? extra}) → Future<T?>: Pushes the location as a new route on top of base.
pushReplacement<T>(String location, {required RouteMatchList base, Object? extra}) → Future<T?>: Removes the top-most route match from base and pushes the location as a new route on top.
removeListener(VoidCallback listener) → void: Remove a previously registered closure from the list of closures that the object notifies.
override
replace<T>(String location, {required RouteMatchList base, Object? extra}) → Future<T?>: Replaces the top-most route match from base with the location.
restore(String location, {required RouteMatchList matchList}) → void: Restores the current route matches with the matchList.
routerReportsNewRouteInformation(RouteInformation routeInformation, {RouteInformationReportingType type = RouteInformationReportingType.none}) → void: A callback called when the Router widget reports new route information
override
toString() → String: A string representation of this object.
inherited

Operators

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