NavigationPort class abstract interface

Application-facing navigation contract independent from its runtime owner.

Features, Presenters, and other application services can depend on this port without receiving graph-editing, restoration, or Flutter Router hooks.

Implemented types
Implementers

Properties

currentUri → Uri
URI represented by the nearest restorable entry in the active branch.
no setter
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
value → NavigationSnapshot
The current value of the object.
no setterinherited

Methods

activateBranch(NavigationScopeId childScopeId, {NavigationHistoryMode historyMode = NavigationHistoryMode.replace}) → Future<NavigationOperationResult>
Selects a child scope as the active branch of its parent.
addListener(VoidCallback listener) → void
Register a closure to be called when the object notifies its listeners.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pop({Object? result, NavigationScopeId? scopeId, NavigationHistoryMode historyMode = NavigationHistoryMode.push}) → Future<NavigationOperationResult>
Pops the top entry in the deepest active or selected scope.
popUntil({required NavigationEntryMatcher anchor, NavigationScopeId? scopeId, NavigationHistoryMode historyMode = NavigationHistoryMode.push}) → Future<NavigationOperationResult>
Pops every entry above anchor.
push<R extends Object?>(NavigationDestination<R> destination, {NavigationMountId? mountId, NavigationScopeId? scopeId, NavigationPresentation? presentation, NavigationHistoryMode historyMode = NavigationHistoryMode.push}) → NavigationTicket<R>
Adds a typed destination to a stack.
pushAndRemoveUntil<R extends Object?>(NavigationDestination<R> destination, {required NavigationEntryMatcher retain, NavigationMountId? mountId, NavigationScopeId? scopeId, NavigationPresentation? presentation, NavigationHistoryMode historyMode = NavigationHistoryMode.push}) → NavigationTicket<R>
Pushes a destination after removing entries above retain.
pushTarget<R extends Object?>(NavigationTarget<R> target, {NavigationHistoryMode historyMode = NavigationHistoryMode.push}) → NavigationTicket<R>
Adds a typed destination with explicit placement constraints.
reconfigureTop<R extends Object?>(NavigationDestination<R> destination, {NavigationMountId? mountId, NavigationScopeId? scopeId, NavigationPresentation? presentation, NavigationHistoryMode historyMode = NavigationHistoryMode.replace}) → Future<NavigationOperationResult>
Reconfigures the top entry while preserving its runtime identity.
remove(NavigationEntryId entryId, {NavigationHistoryMode historyMode = NavigationHistoryMode.replace}) → Future<NavigationOperationResult>
Removes one exact runtime entry.
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that the object notifies.
inherited
replaceAll(List<NavigationTarget<Object?>> targets, {NavigationScopeId? scopeId, NavigationHistoryMode historyMode = NavigationHistoryMode.replace}) → Future<NavigationOperationResult>
Replaces one complete stack atomically.
replaceTail({required NavigationEntryMatcher anchor, required List<NavigationTarget<Object?>> targets, NavigationScopeId? scopeId, NavigationHistoryMode historyMode = NavigationHistoryMode.replace}) → Future<NavigationOperationResult>
Replaces the stack tail above anchor.
replaceTop<R extends Object?>(NavigationDestination<R> destination, {NavigationMountId? mountId, NavigationScopeId? scopeId, NavigationPresentation? presentation, NavigationHistoryMode historyMode = NavigationHistoryMode.replace}) → NavigationTicket<R>
Replaces the top entry with a new typed entry lifecycle.
resetBranch(NavigationScopeId scopeId, {NavigationHistoryMode historyMode = NavigationHistoryMode.replace}) → Future<NavigationOperationResult>
Clears one branch and all of its descendant stacks.
setStack(List<NavigationTarget<Object?>> targets, {NavigationScopeId? scopeId, NavigationHistoryMode historyMode = NavigationHistoryMode.replace}) → Future<NavigationOperationResult>
Declaratively sets one complete stack.
toString() → String
A string representation of this object.
inherited

Operators

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