RouteDeepLink mixin

Mixin for routes that specify deep link handling behavior.

When routes are navigated to via URLs (web deep links or app links), the coordinator uses this mixin to determine how to handle the navigation. Routes without this mixin default to DeeplinkStrategy.replace. Mixin for routes that specify deep link handling behavior.

When routes are navigated to via URLs (web deep links or app links), the coordinator uses this mixin to determine how to handle the navigation. Routes without this mixin default to DeeplinkStrategy.replace.

Superclass constraints

Properties

deeplinkStrategy → DeeplinkStrategy
The strategy to use when handling this deep link.
no setter
hashCode → int
The hash code for this object.
no setterinherited
identifier → Uri
The unique identifier for this route.
no setterinherited
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
parentLayoutKey → 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
createParentLayout(covariant CoordinatorCore<RouteUri> coordinator) → RouteLayoutParent<RouteTarget>?
Creates a new RouteLayoutParent instance for this route.
inherited
deepEquals(RouteTarget other) → bool
Checks deep equality with another route.
inherited
deeplinkHandler(covariant CoordinatorCore<RouteUri> coordinator, Uri uri) → FutureOr<void>
Custom handler called when deeplinkStrategy is DeeplinkStrategy.custom.
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
resolveParentLayout(covariant CoordinatorCore<RouteUri> coordinator) → RouteLayoutParent<RouteTarget>?
Resolves the active or creates a new RouteLayoutParent for this route.
inherited
toString() → String
A string representation of this object.
inherited
toUri() → Uri
Converts this route to a Uri for URL representation.
inherited

Operators

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