RoutePathInfo class sealed

A description of the URI path segment for a state route, when a route tree is enabled for platform routing with TreeStateRouter.platformRouting.

The path can be a literal path like user, or contain parameters that are prefixed by :, like user/:userId. When the router needs to generate a URI representing a route path, it will call generateUriPath for each active route path, passing the active data value (if any) for the route. This data value can be used to generate values for the path parameters.

A path can be enabled for deep linking with enableDeepLink. By default, a path does not support for deep linking. That is, generateUriPath will be used when generate URIs as the active route changes, but will not support navigating directly to the route when following a deep link. If enableDeepLink is true, then additionally matchUriPath will used when parsing a deep link URI.

Implementers

Properties

Indicates if the route supports deep linking.
final
hashCode → int
The hash code for this object.
no setterinherited
parameters → List<String>
The names of parameters in pathTemplate.
final
pathTemplate → String
The path template to use for the associated route, when a routing URI needs to be generated.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

generateUriPath(dynamic data) → String
Generates a path string representing this for use in a URI.
matchUriPath(String uriPath) → UriPathMatch?
Attempts to match the uriPath against this route path
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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