RefreshRouteOptions class abstract

The options to specify how to refresh an already calculated route identified by a RouteHandle.

All the options that may result in a new route shape are ignored as no new route is calculated. Instead, only the data that accompanies a route, such as traffic information, can be refreshed. Therefore, the following route options are ignored: RouteOptions.alternatives, RouteOptions.arrivalTime, and RouteOptions.optimizationMode. If new AvoidanceOptions are specified, they are ignored as well and instead new SectionNotice's are generated that indicate where the requested AvoidanceOptions are violated. Note that when EVCarOptions.ensureReachability is set to true, the route refresh request will fail as this option is incompatible with a fixed route shape. If any of the ignored options are important, consider calculating a new route instead.

Note: This is a beta release of this feature, so there could be a few bugs and unexpected behaviors. Related APIs may change for new releases without a deprecation process.

Annotations
  • @Deprecated("Will be removed in v4.28.0. Use the `RoutingOptions` class instead.")

Constructors

RefreshRouteOptions.withBicycleOptions(BicycleOptions bicycleOptions)
Constructs a RefreshRouteOptions object with BicycleOptions.
factory
RefreshRouteOptions.withBusOptions(BusOptions busOptions)
Constructs a RefreshRouteOptions object with BusOptions.
factory
RefreshRouteOptions.withCarOptions(CarOptions carOptions)
Constructs a RefreshRouteOptions object with CarOptions.
factory
RefreshRouteOptions.withEVCarOptions(EVCarOptions evCarOptions)
Constructs a RefreshRouteOptions object with EVCarOptions.
factory
RefreshRouteOptions.withEVTruckOptions(EVTruckOptions evTruckOptions)
Constructs a RefreshRouteOptions object with EVTruckOptions.
factory
RefreshRouteOptions.withPedestrianOptions(PedestrianOptions pedestrianOptions)
Constructs a RefreshRouteOptions object with PedestrianOptions.
factory
RefreshRouteOptions.withPrivateBusOptions(PrivateBusOptions privateBusOptions)
Constructs a RefreshRouteOptions object with PrivateBusOptions.
factory
RefreshRouteOptions.withScooterOptions(ScooterOptions scooterOptions)
Constructs a RefreshRouteOptions object with ScooterOptions.
factory
RefreshRouteOptions.withTaxiOptions(TaxiOptions taxiOptions)
Constructs a RefreshRouteOptions object with TaxiOptions.
factory
RefreshRouteOptions.withTransportMode(TransportMode transportMode)
Constructs a RefreshRouteOptions object with TransportMode.
factory
RefreshRouteOptions.withTruckOptions(TruckOptions truckOptions)
Constructs a RefreshRouteOptions object with TruckOptions.
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

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