GetDelegate class

Inheritance
Mixed-in types

Constructors

GetDelegate.new({GetPage? notFoundRoute, List<NavigatorObserver>? navigatorObservers, TransitionDelegate? transitionDelegate, PopMode backButtonPopMode = PopMode.History, PreventDuplicateHandlingMode preventDuplicateHandlingMode = PreventDuplicateHandlingMode.ReorderRoutes, Iterable<GetPage> pickPagesForRootNavigator(RouteDecoder currentNavStack)?, String? restorationScopeId, bool showHashOnUrl = false, GlobalKey<NavigatorState>? navigatorKey, required List<GetPage> pages})

Properties

activePages List<RouteDecoder>
no setter
backButtonPopMode PopMode
final
canBack bool
no setter
currentConfiguration RouteDecoder?
Called by the Router when it detects a route information may have changed as a result of rebuild.
no setteroverride
hashCode int
The hash code for this object.
no setterinherited
isDisposed bool
no setterinherited
listenersLength int
no setterinherited
The key used for retrieving the current navigator.
getter/setter pairoverride-getter
final
notFoundRoute GetPage
final
pageSettings PageSettings?
no setter
parameters Map<String, String>
no setter
pickPagesForRootNavigator Iterable<GetPage> Function(RouteDecoder currentNavStack)?
final
preventDuplicateHandlingMode PreventDuplicateHandlingMode
final
restorationScopeId String?
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
transitionDelegate TransitionDelegate?
final

Methods

addListener(GetStateUpdate listener) Disposer
Register a closure to be called when the object notifies its listeners.
inherited
arguments<T>() → T
back<T>([T? result]) → void
override
backAndtoNamed<T, R>(String page, {T? result, Object? arguments}) Future<R?>
override
backUntil(bool predicate(GetPage)) → void
override
build(BuildContext context) Widget
Called by the Router to obtain the widget tree that represents the current state.
override
canPopHistory() Future<bool>
canPopPage() Future<bool>
containsListener(GetStateUpdate listener) bool
inherited
dispose() → void
inherited
getVisualPages(RouteDecoder? currentHistory) Iterable<GetPage>
gets the visual pages from the current _activePages entry
goToUnknownPage([bool clearPages = false]) Future<void>
override
handlePopupRoutes({Object? result}) Future<bool>
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
off<T>(Widget page(), {bool? opaque, Transition? transition, Curve? curve, Duration? duration, int? id, String? routeName, bool fullscreenDialog = false, dynamic arguments, List<BindingsInterface> bindings = const [], bool preventDuplicates = true, bool? popGesture, bool showCupertinoParallax = true, double gestureWidth(BuildContext context)?}) Future<T?>
override
offAll<T>(Widget page(), {bool predicate(GetPage route)?, bool opaque = true, bool? popGesture, int? id, String? routeName, dynamic arguments, List<BindingsInterface> bindings = const [], bool fullscreenDialog = false, Transition? transition, Curve? curve, Duration? duration, bool showCupertinoParallax = true, double gestureWidth(BuildContext context)?}) Future<T?>?
override
offAllNamed<T>(String page, {dynamic arguments, int? id, Map<String, String>? parameters}) Future<T?>?
override
offNamed<T>(String page, {dynamic arguments, int? id, Map<String, String>? parameters}) Future<T?>
override
offNamedUntil<T>(String page, {bool predicate(GetPage route)?, dynamic arguments, int? id, Map<String, String>? parameters}) Future<T?>?
override
offUntil<T>(Widget page(), bool predicate(GetPage), [Object? arguments]) Future<T?>
override
popHistory<T>(T result) Future<T?>
popModeUntil(String fullRoute, {PopMode popMode = PopMode.History}) Future<void>
Removes routes according to PopMode until it reaches the specifc fullRoute, DOES NOT remove the fullRoute
override
popRoute({Object? result, PopMode? popMode}) Future<bool>
Called by the Router when the Router.backButtonDispatcher reports that the operating system is requesting that the current route be popped.
override
refresh() → void
inherited
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that the object notifies.
inherited
removeRoute<T>(String name) → void
reportAdd(VoidCallback disposer) → void
inherited
reportRead() → void
inherited
runMiddleware(RouteDecoder config) Future<RouteDecoder?>
setInitialRoutePath(RouteDecoder configuration) Future<void>
Called by the Router at startup with the structure that the RouteInformationParser obtained from parsing the initial route.
inherited
setNewRoutePath(RouteDecoder configuration) Future<void>
Called by the Router when the Router.routeInformationProvider reports that a new route has been pushed to the application by the operating system.
override
setRestoredRoutePath(RouteDecoder configuration) Future<void>
Called by the Router during state restoration.
inherited
to<T>(Widget page(), {bool? opaque, Transition? transition, Curve? curve, Duration? duration, int? id, String? routeName, bool fullscreenDialog = false, dynamic arguments, List<BindingsInterface> bindings = const [], bool preventDuplicates = true, bool? popGesture, bool showCupertinoParallax = true, double gestureWidth(BuildContext context)?, bool rebuildStack = true, PreventDuplicateHandlingMode preventDuplicateHandlingMode = PreventDuplicateHandlingMode.ReorderRoutes}) Future<T?>
override
toNamed<T>(String page, {dynamic arguments, dynamic id, bool preventDuplicates = true, Map<String, String>? parameters}) Future<T?>
override
toNamedAndOffUntil<T>(String page, bool predicate(GetPage), [Object? data]) Future<T?>
override
toString() String
A string representation of this object.
inherited

Operators

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