RouteIdentity<T> mixin
Mixin that provides route identification capability.
This mixin gives routes a unique identifier that represents them in the
navigation system. The identifier type T determines how the route is
represented:
- Uri: Used by RouteUri for URL-based routing and deep linking
- String: Can be used for simpler in-app route identification
- Custom types: Support for app-specific routing schemes
Role in Navigation Flow
The identifier is used throughout the navigation system:
- CoordinatorCore.currentUri returns the active route's identifier
- Deep link parsing converts URLs to route identifiers
- Stack operations use identifiers to locate routes
Routes typically use RouteUri which implements this mixin with Uri as the identifier type, enabling web URL synchronization.
- Superclass constraints
- Mixin applications
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- identifier → T
-
The unique identifier for this route.
no setter
-
internalProps
→ List<
Object?> -
Framework-managed properties for internal identity.
no setterinherited
- isPopByPath ↔ bool
-
Whether the pop was initiated by the path mechanism.
getter/setter pairinherited
-
onResult
→ Completer<
Object?> -
no setterinherited
-
props
→ List<
Object?> -
Properties used for equality comparison.
no setterinherited
- resultValue → Object?
-
The result value passed when this route was popped.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
stackPath
→ StackPath<
RouteTarget> ? -
The StackPath that contains this route.
no setterinherited
Methods
-
bindResultValue(
Object? value) → void -
inherited
-
bindStackPath(
StackPath< RouteTarget> path) → void -
Binds the route to a path.
inherited
-
clearStackPath(
) → void -
Clears the path binding.
inherited
-
compareWith(
Object other) → bool -
Compares this object with another for equality.
inherited
-
completeOnResult(
Object? result, covariant CoordinatorCore< RouteUri> ? coordinator, [bool failSilent = false]) → void -
Completes the route's result future.
inherited
-
deepEquals(
RouteTarget other) → bool -
Checks deep equality with another route.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onDidPop(
Object? result, covariant CoordinatorCore< RouteUri> ? coordinator) → void -
Called when the route is popped from the navigation stack.
inherited
-
onDiscard(
) → void -
Called when the route is discarded without being displayed.
inherited
-
onUpdate(
covariant RouteTarget newRoute) → void -
Called when this route is updated with state from a new route instance.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited