restorablePushNamedAndRemoveUntil<T extends Object?> method

  1. @optionalTypeArgs
String restorablePushNamedAndRemoveUntil<T extends Object?>(
  1. String newRouteName,
  2. RoutePredicate predicate,
  3. {Object? arguments}

Push the route with the given name onto the navigator, and then remove all the previous routes until the predicate returns true.

Unlike Routes pushed via pushNamedAndRemoveUntil, Routes pushed with this method are restored during state restoration according to the rules outlined in the "State Restoration" section of Navigator.

The predicate may be applied to the same route more than once if Route.willHandlePopInternally is true.

To remove routes until a route with a certain name, use the RoutePredicate returned from ModalRoute.withName.

To remove all the routes below the pushed route, use a RoutePredicate that always returns false (e.g. (Route<dynamic> route) => false).

The removed routes are removed without being completed, so this method does not take a return value argument.

The new route's name (routeName) will be passed to the Navigator.onGenerateRoute callback. The returned route will be pushed into the navigator.

The new route and the route below the bottommost removed route (which becomes the route below the new route) are notified (see Route.didPush and Route.didChangeNext). If the Navigator has any Navigator.observers, they will be notified as well (see NavigatorObserver.didPush and NavigatorObserver.didRemove). The removed routes are disposed, without being notified, once the new route has finished animating. The futures that had been returned from pushing those routes will not complete.

Ongoing gestures within the current route are canceled when a new route is pushed.

The T type argument is the type of the return value of the new route.

To use pushNamedAndRemoveUntil, an Navigator.onGenerateRoute callback must be provided.

The provided arguments are passed to the pushed route via RouteSettings.arguments. Any object that is serializable via the StandardMessageCodec can be passed as arguments. Often, a Map is used to pass key-value pairs.

The arguments may be used in Navigator.onGenerateRoute or Navigator.onUnknownRoute to construct the route.

The method returns an opaque ID for the pushed route that can be used by the RestorableRouteFuture to gain access to the actual Route object added to the navigator and its return value. You can ignore the return value of this method, if you do not care about the route object or the route's return value.

Typical usage is as follows:
void _openCalendar() {
  navigator.restorablePushNamedAndRemoveUntil('/calendar', ModalRoute.withName('/'));


String restorablePushNamedAndRemoveUntil<T extends Object?>(
  String newRouteName,
  RoutePredicate predicate, {
  Object? arguments,
}) {
  assert(debugIsSerializableForRestoration(arguments), 'The arguments object must be serializable via the StandardMessageCodec.');
  final _RouteEntry entry = _RestorationInformation.named(
    name: newRouteName,
    arguments: arguments,
    restorationScopeId: _nextPagelessRestorationScopeId,
  ).toRouteEntry(this, initialState: _RouteLifecycle.push);
  _pushEntryAndRemoveUntil(entry, predicate);
  return entry.restorationId!;