NavigateAction<St> class

Available constructors: NavigateAction.push(), NavigateAction.pop(), NavigateAction.popAndPushNamed(), NavigateAction.pushNamed(), NavigateAction.pushReplacement(), NavigateAction.pushAndRemoveUntil(), NavigateAction.replace(), NavigateAction.replaceRouteBelow(), NavigateAction.pushReplacementNamed(), NavigateAction.pushNamedAndRemoveUntil(), NavigateAction.pushNamedAndRemoveAll(), NavigateAction.popUntil(), NavigateAction.removeRoute(), NavigateAction.removeRouteBelow(), NavigateAction.popUntilRouteName(), NavigateAction.popUntilRoute(),




details NavigatorDetails
dispatch Dispatch<St>
read-only, inherited
dispatchFuture DispatchFuture<St>
read-only, inherited
hasFinished bool
Returns true only if the action finished with no errors. In other words, if the methods before, reduce and after all finished executing without throwing any errors.
read-only, inherited
hashCode int
The hash code for this object. [...]
read-only, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
state → St
read-only, inherited
stateTimestamp DateTime
read-only, inherited
status ActionStatus
read-only, inherited
store Store<St>
read-only, inherited
type NavigateType
This is useful for tests only. You can test that some dispatched NavigateAction was of a certain type.


abortDispatch() bool
If this returns true, the action will not be dispatched: before, reduce and after will not be called, and the action will not be visible to the StoreTester. This is only useful under rare circumstances, and you should only use it if you know what you are doing.
after() → void
This is an optional method that may be overridden to run during action dispatching, after reduce. If this method throws an error, the error will be swallowed (will not throw). So you should only run code that can't throw errors. It may be synchronous only. Note this method will always be called, even if errors were thrown by before or reduce.
before() FutureOr<void>
This is an optional method that may be overridden to run during action dispatching, before reduce. If this method throws an error, the reduce method will NOT run, but the method after will. It may be synchronous (returning void) ou async (returning Future<void>).
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
reduce() → St
The reduce method is the action reducer. It may read the action state, the store state, and then return a new state (or null if no state change is necessary). [...]
reduceWithState(Store<St> store, St state) FutureOr<St>
Nest state reducers without dispatching another action. Example: return AddTaskAction(demoTask).reduceWithState(state);
@Deprecated('This is deprecated and will be removed soon, ' 'because it's more difficult to use than it seems. ' 'Unless you completely understand what you're doing,' 'you should only used it with sync reducers.'), inherited
setStore(Store<St> store) → void
toString() String
Returns a string representation of this object.
wrapError(dynamic error) Object
If any error is thrown by reduce or before, you have the chance to further process it by using wrapError. Usually this is used to wrap the error inside of another that better describes the failed action. For example, if some action converts a String into a number, then instead of throwing a FormatException you could do: wrapError(error) => UserException("Please enter a valid number.", error: error)
wrapReduce(Reducer<St> reduce) Reducer<St>
You may wrap the reducer to allow for some pre or post-processing. For example, if you want to abort an async reducer if the state changed since when the reducer started: [...]


operator ==(Object other) bool
The equality operator. [...]

Static Properties


Static Methods

getCurrentNavigatorRouteName(BuildContext context) String
Trick explained here: Note 'ModalRoute.of(context)' doesn't always work.
setNavigatorKey(GlobalKey<NavigatorState> navigatorKey) → void