Package com.here.sdk.routing

Class RefreshRouteOptions

  • public final class RefreshRouteOptions
extends NativeBase

    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.

    • Constructor Detail

      • RefreshRouteOptions

        public RefreshRouteOptions​(@NonNull
                           TransportMode transportMode)

        Constructs a RefreshRouteOptions object with TransportMode.

        Parameters:
        transportMode -

        Updates the transport mode for the route.

      • RefreshRouteOptions

        public RefreshRouteOptions​(@NonNull
                           CarOptions carOptions)

        Constructs a RefreshRouteOptions object with CarOptions.

        Parameters:
        carOptions -

        Converts the route to a car route, if a different transport mode was used for the RouteHandle. Note that in case this is not possible, an RoutingError.NO_ROUTE_FOUND error will be triggered.

      • RefreshRouteOptions

        public RefreshRouteOptions​(@NonNull
                           TruckOptions truckOptions)

        Constructs a RefreshRouteOptions object with TruckOptions.

        Parameters:
        truckOptions -

        Converts the route to a truck route, if a different transport mode was used for the RouteHandle. Note that in case this is not possible, an RoutingError.NO_ROUTE_FOUND error will be triggered.

      • RefreshRouteOptions

        public RefreshRouteOptions​(@NonNull
                           PedestrianOptions pedestrianOptions)

        Constructs a RefreshRouteOptions object with PedestrianOptions.

        Parameters:
        pedestrianOptions -

        Converts the route to a pedestrian route, if a different transport mode was used for the RouteHandle. Note that in case this is not possible, an RoutingError.NO_ROUTE_FOUND error will be triggered.

      • RefreshRouteOptions

        public RefreshRouteOptions​(@NonNull
                           ScooterOptions scooterOptions)

        Constructs a RefreshRouteOptions object with ScooterOptions.

        Parameters:
        scooterOptions -

        Converts the route to a scooter route, if a different transport mode was used for the RouteHandle. Note that in case this is not possible, an RoutingError.NO_ROUTE_FOUND error will be triggered.

      • RefreshRouteOptions

        public RefreshRouteOptions​(@NonNull
                           TaxiOptions taxiOptions)

        Constructs a RefreshRouteOptions object with TaxiOptions.

        Parameters:
        taxiOptions -

        Converts the route to a taxi route, if a different transport mode was used for the RouteHandle. Note that in case this is not possible, an RoutingError.NO_ROUTE_FOUND error will be triggered.

      • RefreshRouteOptions

        public RefreshRouteOptions​(@NonNull
                           EVCarOptions evCarOptions)

        Constructs a RefreshRouteOptions object with EVCarOptions.

        Parameters:
        evCarOptions -

        Converts the route to an electric car route, if a different transport mode was used for the RouteHandle. Note that in case this is not possible, an RoutingError.NO_ROUTE_FOUND error will be triggered.

      • RefreshRouteOptions

        public RefreshRouteOptions​(@NonNull
                           EVTruckOptions evTruckOptions)

        Constructs a RefreshRouteOptions object with EVTruckOptions.

        Parameters:
        evTruckOptions -

        Converts the route to an electric truck route, if a different transport mode was used for the RouteHandle. Note that in case this is not possible, an RoutingError.NO_ROUTE_FOUND error will be triggered.

      • RefreshRouteOptions

        public RefreshRouteOptions​(@NonNull
                           BicycleOptions bicycleOptions)

        Constructs a RefreshRouteOptions object with BicycleOptions.

        Parameters:
        bicycleOptions -

        Converts the route to a bicycle route, if a different transport mode was used for the RouteHandle. Note that in case this is not possible, an RoutingError.NO_ROUTE_FOUND error will be triggered.

      • RefreshRouteOptions

        public RefreshRouteOptions​(@NonNull
                           BusOptions busOptions)

        Constructs a RefreshRouteOptions object with BusOptions.

        Parameters:
        busOptions -

        Converts the route to a bus route, if a different transport mode was used for the RouteHandle. Note that in case this is not possible, an RoutingError.NO_ROUTE_FOUND error will be triggered.

      • RefreshRouteOptions

        public RefreshRouteOptions​(@NonNull
                           PrivateBusOptions privateBusOptions)

        Constructs a RefreshRouteOptions object with PrivateBusOptions.

        Parameters:
        privateBusOptions -

        Converts the route to a private bus route, if a different transport mode was used for the RouteHandle. Note that in case this is not possible, an RoutingError.NO_ROUTE_FOUND error will be triggered.