RoutingEngine Class Reference


                    
                    
                    init()

Creates a new instance of this class.

Throws

InstantiationError Indicates what went wrong when the instantiation was attempted.

Declaration

Swift

public init() throws


                    
                    
                    init(_:)

Creates a new instance of RoutingEngine.

Throws

InstantiationError Indicates what went wrong when the instantiation was attempted.

Declaration

Swift

public init(_ sdkEngine: SDKNativeEngine) throws

Parameters


                                sdkEngine

An SDKEngine instance.


                    
                    
                    init(connectionSettings:)

Creates a new instance of RoutingEngine.

Throws

InstantiationError Indicates what went wrong when the instantiation was attempted.

Declaration

Swift

public init(connectionSettings: RoutingConnectionSettings) throws

Parameters


                                connectionSettings

Settings for the route calculation.


                    
                    
                    init(_:connectionSettings:)

Creates a new instance of RoutingEngine.

Throws

InstantiationError Indicates what went wrong when the instantiation was attempted.

Declaration

Swift

public init(_ sdkEngine: SDKNativeEngine, connectionSettings: RoutingConnectionSettings) throws

Parameters

`sdkEngine`	An SDKEngine instance.
`connectionSettings`	Settings for the route calculation.


                    
                    
                    calculateRoute(with:options:completion:)

Asynchronously calculates a route from one point to another, passing through the given waypoints in the given order. 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.

Declaration

Swift

@discardableResult
public func calculateRoute(with waypoints: [Waypoint], options: RoutingOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`waypoints`	The list of waypoints used to calculate the route. The first element marks the starting position, the last marks the destination. Waypoints in between are interpreted as intermediate.
`options`	Options describing routing options.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    calculateRoute(with:carOptions:completion:)

Asynchronously calculates a car route from one point to another, passing through the given waypoints in the given order.

Declaration

Swift

@discardableResult
public func calculateRoute(with waypoints: [Waypoint], carOptions: CarOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`waypoints`	The list of waypoints used to calculate the route. The first element marks the starting position, the last marks the destination. Waypoints in between are interpreted as intermediate.
`carOptions`	Options specific for car route calculation, along with common route options.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    calculateRoute(with:pedestrianOptions:completion:)

Asynchronously calculates a pedestrian route from one point to another, passing through the given waypoints in the given order.

Declaration

Swift

@discardableResult
public func calculateRoute(with waypoints: [Waypoint], pedestrianOptions: PedestrianOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`waypoints`	The list of waypoints used to calculate the route. The first element marks the starting position, the last marks the destination. Waypoints in between are interpreted as intermediate.
`pedestrianOptions`	Options specific for pedestrian route calculation, along with common route options. Note that `OptimizationMode.shortest` is is not supported for pedestrians and converted to `OptimizationMode.fastest` automatically.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    calculateRoute(with:truckOptions:completion:)

Asynchronously calculates a truck route from one point to another, passing through the given waypoints in the given order.

Declaration

Swift

@discardableResult
public func calculateRoute(with waypoints: [Waypoint], truckOptions: TruckOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`waypoints`	The list of waypoints used to calculate the route. The first element marks the starting position, the last marks the destination. Waypoints in between are interpreted as intermediate.
`truckOptions`	Options specific for truck route calculation, along with common route options.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    calculateRoute(with:scooterOptions:completion:)

Asynchronously calculates a scooter route from one point to another, passing through the given waypoints in the given order.

Declaration

Swift

@discardableResult
public func calculateRoute(with waypoints: [Waypoint], scooterOptions: ScooterOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`waypoints`	The list of waypoints used to calculate the route. The first element marks the starting position, the last marks the destination. Waypoints in between are interpreted as intermediate.
`scooterOptions`	Options specific for scooter route calculation, along with common route options. Note that `OptimizationMode.shortest` is is not supported for scooters and converted to `OptimizationMode.fastest` automatically.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    calculateRoute(with:bicycleOptions:completion:)

Asynchronously calculates a bicycle route from one point to another, passing through the given waypoints in the given order.

Declaration

Swift

@discardableResult
public func calculateRoute(with waypoints: [Waypoint], bicycleOptions: BicycleOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`waypoints`	The list of waypoints used to calculate the route. The first element marks the starting position, the last marks the destination. Waypoints in between are interpreted as intermediate.
`bicycleOptions`	Options specific for bicycle route calculation, along with common route options. Note that `OptimizationMode.shortest` is is not supported for bicycles and converted to `OptimizationMode.fastest` automatically.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    calculateRoute(with:taxiOptions:completion:)

Asynchronously calculates a taxi route from one point to another, passing through the given waypoints in the given order.

Declaration

Swift

@discardableResult
public func calculateRoute(with waypoints: [Waypoint], taxiOptions: TaxiOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`waypoints`	The list of waypoints used to calculate the route. The first element marks the starting position, the last marks the destination. Waypoints in between are interpreted as intermediate.
`taxiOptions`	Options specific for taxi route calculation, along with common route options. Note that `OptimizationMode.shortest` is is not supported for taxis and converted to `OptimizationMode.fastest` automatically.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    calculateRoute(with:evCarOptions:completion:)

Asynchronously calculates an electric car route from one point to another, passing through the given waypoints in the given order.

Declaration

Swift

@discardableResult
public func calculateRoute(with waypoints: [Waypoint], evCarOptions: EVCarOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`waypoints`	The list of waypoints used to calculate the route. The first element marks the starting position, the last marks the destination. Waypoints in between are interpreted as intermediate.
`evCarOptions`	Options specific for an electric car route calculation, along with common route options.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    calculateRoute(with:evTruckOptions:completion:)

Asynchronously calculates an electic truck route from one point to another, passing through the given waypoints in the given order.

Declaration

Swift

@discardableResult
public func calculateRoute(with waypoints: [Waypoint], evTruckOptions: EVTruckOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`waypoints`	The list of waypoints used to calculate the route. The first element marks the starting position, the last marks the destination. Waypoints in between are interpreted as intermediate.
`evTruckOptions`	Options specific for an electric truck route calculation, along with common route options.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    calculateRoute(with:busOptions:completion:)

Asynchronously calculates a bus route from one point to another, passing through the given waypoints in the given order.

Declaration

Swift

@discardableResult
public func calculateRoute(with waypoints: [Waypoint], busOptions: BusOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`waypoints`	The list of waypoints used to calculate the route. The first element marks the starting position, the last marks the destination. Waypoints in between are interpreted as intermediate.
`busOptions`	Options specific for a bus route calculation, along with common route options.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    calculateRoute(with:privateBusOptions:completion:)

Asynchronously calculates a private bus route from one point to another, passing through the given waypoints in the given order.

Declaration

Swift

@discardableResult
public func calculateRoute(with waypoints: [Waypoint], privateBusOptions: PrivateBusOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`waypoints`	The list of waypoints used to calculate the route. The first element marks the starting position, the last marks the destination. Waypoints in between are interpreted as intermediate.
`privateBusOptions`	Options specific for a private bus route calculation, along with common route options.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    returnToRoute(_:startingPoint:lastTraveledSectionIndex:traveledDistanceOnLastSectionInMeters:completion:)

Asynchronously calculates a new route that leads back to the original route. The part of the original route which was already traveled by the user is ignored.

Note: Stopover waypoints are guaranteed to be visited. Pass-through waypoints will be ignored. Additionally, the following route options are ignored: RouteOptions.alternatives, RouteOptions.arrivalTime, and RouteOptions.optimizationMode. Most route options are only applied to the newly calculated part back to the route.

An application may use this method to submit a new starting point for a previously calculated route. This method tries to avoid a costly route re-calculation as much as possible. In case returning to the route without re-calculation is not possible, a new route is calculated, while trying to salvage the previous route as much as possible. However, a completely new route containing no part of the previous route is possible, too.

Note that this function uses only a limited amount of map data around the new origin. Therefore, it may also work fine with temporarily cached map data. It may also copy some of the original route data into the new route.

A typical use case is to await at least 3 RouteDeviation events before calling this method.

Or alternatively, wait at least 10 seconds after getting the first deviation event.
On top, the user experience can be improved by checking if the vehicle has moved at least 50 meters since calling this method for the last time.
Optionally, it may make sense to verify if the vehicle was ever following the route by checking if RouteDeviation.lastLocationOnRoute is set.

Note that deviation events are sent each time a deviation is detected, i.e. for each new location update, regardless if the location has changed or not. More information can be found in the Developer Guide in the “Handle route deviations” section.

Declaration

Swift

@discardableResult
public func returnToRoute(_ route: Route, startingPoint: Waypoint, lastTraveledSectionIndex: Int32, traveledDistanceOnLastSectionInMeters: Int32, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`route`	A `Route` calculated using the online or offline route engine. For the offline case, It should not contain an indoor `Section` as such routes will fail. For the online case, it should have `RouteHandle`.
`startingPoint`	The current location, for example, provided by a `RouteDeviation` event. The waypoint needs to be of type `WaypointType.stopover`. Otherwise, an `RoutingError.invalidParameter` error is generated.
`lastTraveledSectionIndex`	Indicates the index of the last traveled route section. Traveled part of the route won’t be reused.
`traveledDistanceOnLastSectionInMeters`	Offset in meter to the last visited position on the route section defined by the last traveled section index.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    refreshRoute(routeHandle:startingPoint:refreshRouteOptions:completion:)

Asynchronously refreshes a previously calculated route from the provided RouteHandle, updating the starting point and route metadata based on RefreshRouteOptions. The route shape from the new starting point to the destination remains unchanged, and only metadata such as arrival time and traffic delays are updated. If you only want to refresh the contained traffic information or retrieve updated ETA duration, consider using RoutingEngine.calculateTrafficOnRoute(Route, Int32, Int32, Double, CalculateTrafficOnRouteCompletionHandler) instead.

Calling this method will trigger a new “HERE Routing” transaction, for example, if you are using the Base Plan.

Declaration

Swift

@discardableResult
public func refreshRoute(routeHandle: RouteHandle, startingPoint: Waypoint, refreshRouteOptions: RefreshRouteOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`routeHandle`	The route handle holding the route to be refreshed.
`startingPoint`	Updates the starting point of the route. It should be of type `WaypointType.stopover`. Otherwise, an `RoutingError.invalidParameter` error is generated. Moreover, it should be very close to the original route specified with the `RouteHandle`. Since the new starting point is expected to be along the original route, the original route geometry is used to reach the remaining waypoints. The new route will not include the `Waypoint` items that lie behind the new starting point (i.e. the path that was already travelled). Plus, `Route.lengthInMeters` and `Route.duration` values are from the new starting point to the destination. If the new waypoint is too far off the original route, the route refresh may fail and an `RoutingError.couldNotMatchOrigin` error is triggered. In that case, an application may decide to calculate a new route from scratch.
`refreshRouteOptions`	Options to refresh the route.
`completion`	Callback object that will be invoked after refreshing the route. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    refreshRoute(routeHandle:startingPoint:lastTraveledSectionIndex:traveledDistanceOnLastSectionInMeters:refreshRouteOptions:completion:)

Asynchronously refreshes a previously calculated route from the provided RouteHandle, updating the starting point and route metadata based on RefreshRouteOptions. The route shape from the new starting point to the destination remains unchanged, and only metadata such as arrival time and traffic delays are updated. If you only want to refresh the contained traffic information, consider to use RoutingEngine.calculateTrafficOnRoute(Route, Int32, Int32, Double, CalculateTrafficOnRouteCompletionHandler) instead.

Calling this method will trigger a new “HERE Routing” transaction, for example, if you are using the Base Plan.

Declaration

Swift

@discardableResult
public func refreshRoute(routeHandle: RouteHandle, startingPoint: Waypoint?, lastTraveledSectionIndex: Int32?, traveledDistanceOnLastSectionInMeters: Int32?, refreshRouteOptions: RefreshRouteOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`routeHandle`	The route handle holding the route to be refreshed.
`startingPoint`	Updates the starting point of the route. It should be of type `WaypointType.stopover`. Otherwise, an `RoutingError.invalidParameter` error is generated. Moreover, it should be very close to the original route specified with the `RouteHandle`. Since the new starting point is expected to be along the original route, the original route geometry is used to reach the remaining waypoints. The new route will not include the `Waypoint` items that lie behind the new starting point (i.e. the path that was already travelled). Plus, `Route.lengthInMeters` and `Route.duration` values are from the new starting point to the destination. If the new waypoint is too far off the original route, the route refresh may fail and an `RoutingError.couldNotMatchOrigin` error is triggered. In that case, an application may decide to calculate a new route from scratch.
`lastTraveledSectionIndex`	Indicates the index of the last traveled route section. Traveled part of the route won’t be reused.
`traveledDistanceOnLastSectionInMeters`	Offset in meter to the last visited position on the route section defined by the last traveled section index.
`refreshRouteOptions`	Options to refresh the route.
`completion`	Callback object that will be invoked after refreshing the route. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    refreshRoute(routeHandle:startingPoint:lastTraveledSectionIndex:traveledDistanceOnLastSectionInMeters:options:completion:)

Asynchronously refreshes a previously calculated route from the provided RouteHandle, updating the starting point and route metadata based on RoutingOptions. The route shape from the new starting point to the destination remains unchanged, and only metadata such as arrival time and traffic delays are updated. If you only want to refresh the contained traffic information, consider to use RoutingEngine.calculateTrafficOnRoute(Route, Int32, Int32, Double, CalculateTrafficOnRouteCompletionHandler) instead.

Calling this method will trigger a new “HERE Routing” transaction, for example, if you are using the Base Plan. 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.

Declaration

Swift

@discardableResult
public func refreshRoute(routeHandle: RouteHandle, startingPoint: Waypoint?, lastTraveledSectionIndex: Int32?, traveledDistanceOnLastSectionInMeters: Int32?, options: RoutingOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`routeHandle`	The route handle holding the route to be refreshed.
`startingPoint`	Updates the starting point of the route. It should be of type `WaypointType.stopover`. Otherwise, an `RoutingError.invalidParameter` error is generated. Moreover, it should be very close to the original route specified with the `RouteHandle`. Since the new starting point is expected to be along the original route, the original route geometry is used to reach the remaining waypoints. The new route will not include the `Waypoint` items that lie behind the new starting point (i.e. the path that was already traveled). Plus, `Route.lengthInMeters` and `Route.duration` values are from the new starting point to the destination. If the new waypoint is too far off the original route, the route refresh may fail and an `RoutingError.couldNotMatchOrigin` error is triggered. In that case, an application may decide to calculate a new route from scratch.
`lastTraveledSectionIndex`	Indicates the index of the last traveled route section. Traveled part of the route won’t be reused.
`traveledDistanceOnLastSectionInMeters`	Offset in meter to the last visited position on the route section defined by the last traveled section index.
`options`	The options define the vehicle and route options to calculate the route.
`completion`	Callback object that will be invoked after refreshing the route. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    refreshRoute(routeHandle:startingPoint:options:completion:)

Asynchronously refreshes a previously calculated route from the provided RouteHandle, updating the starting point and route metadata based on RoutingOptions. The route shape from the new starting point to the destination remains unchanged, and only metadata such as arrival time and traffic delays are updated. If you only want to refresh the contained traffic information, consider to use RoutingEngine.calculateTrafficOnRoute(Route, Int32, Int32, Double, CalculateTrafficOnRouteCompletionHandler) instead.

Calling this method will trigger a new “HERE Routing” transaction, for example, if you are using the Base Plan. 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.

Declaration

Swift

@discardableResult
public func refreshRoute(routeHandle: RouteHandle, startingPoint: Waypoint, options: RoutingOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`routeHandle`	The route handle holding the route to be refreshed.
`startingPoint`	Updates the starting point of the route. It should be of type `WaypointType.stopover`. Otherwise, an `RoutingError.invalidParameter` error is generated. Moreover, it should be very close to the original route specified with the `RouteHandle`. Since the new starting point is expected to be along the original route, the original route geometry is used to reach the remaining waypoints. The new route will not include the `Waypoint` items that lie behind the new starting point (i.e. the path that was already traveled). Plus, `Route.lengthInMeters` and `Route.duration` values are from the new starting point to the destination. If the new waypoint is too far off the original route, the route refresh may fail and an `RoutingError.couldNotMatchOrigin` error is triggered. In that case, an application may decide to calculate a new route from scratch.
`options`	The options define the vehicle and route options to calculate the route.
`completion`	Callback object that will be invoked after refreshing the route. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(routeHandle:refreshRouteOptions:completion:)

Asynchronously recreates a route from the RouteHandle provided, i.e. refreshes a previously calculated route, with the specified RefreshRouteOptions.

A route handle can be invalid when the map data changes that is used by the HERE backend to recreate the route. This happens regularly. Therefore, the route handle is not meant to be persisted for a longer time. Instead, a possible use case can be to plan a route with another HERE service. For example, a HERE REST API that allows to calculate a route on a desktop. Then this route can be transferred via the handle to a mobile device for further use with the HERE SDK.

Declaration

Swift

@discardableResult
public func importRoute(routeHandle: RouteHandle, refreshRouteOptions: RefreshRouteOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`routeHandle`	The route handle holding the route to be refreshed.
`refreshRouteOptions`	The options define the vehicle and route options to calculate the route. Note An [sdk.routing.RoutingError.INVALID_PARAMETER] is generated when the [sdk.routing.EVCarOptions.ensure_reachability] option is set to `true`.
`completion`	Callback object that will be invoked after refreshing the route. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:carOptions:completion:)

Asynchronously creates a car route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices .

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], carOptions: CarOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`carOptions`	Options specific for car route calculation, along with common route options.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:routeStops:pedestrianOptions:completion:)

Asynchronously creates a pedestrian route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices .

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], routeStops: [RouteStop], pedestrianOptions: PedestrianOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`routeStops`	The list of RouteStop’s which contains index of location from locations list used for route stop and duration in seconds spent on stop.
`pedestrianOptions`	Options specific for pedestrian route calculation, along with common route options. Note that `OptimizationMode.shortest` is not supported for pedestrians and converted to `OptimizationMode.fastest` automatically.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:routeStops:bicycleOptions:completion:)

Asynchronously creates a bicycle route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices .

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], routeStops: [RouteStop], bicycleOptions: BicycleOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`routeStops`	The list of RouteStop’s which contains index of location from locations list used for route stop and duration in seconds spent on stop.
`bicycleOptions`	Options specific for bicycle route calculation, along with common route options.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:routeStops:scooterOptions:completion:)

Asynchronously creates a scooter route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices .

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], routeStops: [RouteStop], scooterOptions: ScooterOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`routeStops`	The list of RouteStop’s which contains index of location from locations list used for route stop and duration in seconds spent on stop.
`scooterOptions`	Options specific for scooter route calculation, along with common route options. Note that `OptimizationMode.shortest` is not supported for scooters and converted to `OptimizationMode.fastest` automatically.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:pedestrianOptions:completion:)

Asynchronously creates a pedestrian route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices .

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], pedestrianOptions: PedestrianOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`pedestrianOptions`	Options specific for pedestrian route calculation, along with common route options. Note that `OptimizationMode.shortest` is not supported for pedestrians and converted to `OptimizationMode.fastest` automatically.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:bicycleOptions:completion:)

Asynchronously creates a bicycle route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices .

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], bicycleOptions: BicycleOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`bicycleOptions`	Options specific for bicycle route calculation, along with common route options.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:scooterOptions:completion:)

Asynchronously creates a scooter route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices .

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], scooterOptions: ScooterOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`scooterOptions`	Options specific for scooter route calculation, along with common route options. Note that `OptimizationMode.shortest` is not supported for scooters and converted to `OptimizationMode.fastest` automatically.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:truckOptions:completion:)

Asynchronously creates a truck route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices .

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], truckOptions: TruckOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`truckOptions`	Options specific for truck route calculation, along with common route options.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:taxiOptions:completion:)

Asynchronously creates a taxi route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices .

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], taxiOptions: TaxiOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`taxiOptions`	Options specific for taxi route calculation, along with common route options. Note that `OptimizationMode.shortest` is not supported for taxis and converted to `OptimizationMode.fastest` automatically.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:busOptions:completion:)

Asynchronously creates a bus route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices .

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], busOptions: BusOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`busOptions`	Options specific for bus route calculation, along with common route options.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:privateBusOptions:completion:)

Asynchronously creates a private bus route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or anyway geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices .

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], privateBusOptions: PrivateBusOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`privateBusOptions`	Options specific for private bus route calculation, along with common route options.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:evCarOptions:completion:)

Asynchronously creates an electric car route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices .

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], evCarOptions: EVCarOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`evCarOptions`	Options specific for an electric car route calculation, along with common route options. Note An [sdk.routing.RoutingError.INVALID_PARAMETER] is generated when the [sdk.routing.EVCarOptions.ensure_reachability] option is set to `true`.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:evTruckOptions:completion:)

Asynchronously creates an electric truck route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices .

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], evTruckOptions: EVTruckOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`evTruckOptions`	Options specific for an electric truck route calculation, along with common route options.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:routeStops:carOptions:completion:)

Asynchronously creates a car route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices .

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], routeStops: [RouteStop], carOptions: CarOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`routeStops`	The list of RouteStop’s which contains index of location from locations list used for route stop and duration in seconds spent on stop.
`carOptions`	Options specific for car route calculation, along with common route options.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:routeStops:truckOptions:completion:)

Asynchronously creates a truck route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices .

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], routeStops: [RouteStop], truckOptions: TruckOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`routeStops`	The list of RouteStop’s which contains index of location from locations list used for route stop and duration in seconds spent on stop.
`truckOptions`	Options specific for truck route calculation, along with common route options.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:routeStops:taxiOptions:completion:)

Asynchronously creates a taxi route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices .

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], routeStops: [RouteStop], taxiOptions: TaxiOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`routeStops`	The list of RouteStop’s which contains index of location from locations list used for route stop and duration in seconds spent on stop.
`taxiOptions`	Options specific for taxi route calculation, along with common route options. Note that `OptimizationMode.shortest` is not supported for taxis and converted to `OptimizationMode.fastest` automatically.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:routeStops:busOptions:completion:)

Asynchronously creates a bus route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices .

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], routeStops: [RouteStop], busOptions: BusOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`routeStops`	The list of RouteStop’s which contains index of location from locations list used for route stop and duration in seconds spent on stop.
`busOptions`	Options specific for bus route calculation, along with common route options.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:routeStops:privateBusOptions:completion:)

Asynchronously creates a private bus route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or anyway geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices .

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], routeStops: [RouteStop], privateBusOptions: PrivateBusOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`routeStops`	The list of RouteStop’s which contains index of location from locations list used for route stop and duration in seconds spent on stop.
`privateBusOptions`	Options specific for private bus route calculation, along with common route options.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:routeStops:evCarOptions:completion:)

Asynchronously creates an electric car route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices .

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], routeStops: [RouteStop], evCarOptions: EVCarOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`routeStops`	The list of RouteStop’s which contains index of location from locations list used for route stop and duration in seconds spent on stop.
`evCarOptions`	Options specific for an electric car route calculation, along with common route options. Note An [sdk.routing.RoutingError.INVALID_PARAMETER] is generated when the [sdk.routing.EVCarOptions.ensure_reachability] option is set to `true`.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:routeStops:evTruckOptions:completion:)

Asynchronously creates an electric truck route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices .

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], routeStops: [RouteStop], evTruckOptions: EVTruckOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`routeStops`	The list of RouteStop’s which contains index of location from locations list used for route stop and duration in seconds spent on stop.
`evTruckOptions`	Options specific for an electric truck route calculation, along with common route options.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:options:completion:)

Asynchronously creates a route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices. 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.

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], options: RoutingOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`options`	The options define the vehicle and route options to calculate the route.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(with:routeStops:options:completion:)

Asynchronously creates a route from a sequence of geographic coordinates very close to each other. The route shape will be kept as close as possible to the one provided. For best results please use 1Hz GPS data, or geographic coordinates that have a spacing of a few meters one from the other. For example, such a list of geographic coordinates can be extracted from a GPX trace or a route object from a 3rd party library. Very sparse data may be rejected by the service with an error.

Note: Any restrictions applied to a transport type or provided options will be discarded and reported as violations in Section.sectionNotices . 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.

Declaration

Swift

@discardableResult
public func importRoute(with locations: [Location], routeStops: [RouteStop], options: RoutingOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`locations`	The list of locations used to calculate the route. Note that only the `Location.coordinates` of a location are used to import the route.
`routeStops`	The list of RouteStop’s which contains index of location from locations list used for route stop and duration in seconds spent on stop.
`options`	The options define the vehicle and route options to calculate the route.
`completion`	Callback object that will be invoked after route calculation. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    importRoute(routeHandle:options:completion:)

Asynchronously recreates a route from the RouteHandle provided, i.e. refreshes a previously calculated route, with the specified RefreshRouteOptions.

A route handle can be invalid when the map data changes that is used by the HERE sdk to recreate the route. This happens regularly. Therefore, the route handle is not meant to be persisted for a longer time. 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.

Declaration

Swift

@discardableResult
public func importRoute(routeHandle: RouteHandle, options: RoutingOptions, completion: @escaping CalculateRouteCompletionHandler) -> TaskHandle

Parameters

`routeHandle`	The route handle holding the route to be refreshed.
`options`	The options define the vehicle and route options to calculate the route.
`completion`	Callback object that will be invoked after refreshing the route. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    calculateTrafficOnRoute(route:lastTraveledSectionIndex:traveledDistanceOnLastSectionInMeters:completion:)

Asynchronously calculates the traffic along a route starting from the index of the last traveled route section and an offset (in meters) from the last visited position on the section. Call this when only the contained traffic information or the latest ETA duration is needed. This can be called periodically to retrieve updated ETA values during navigation.

Note: Calling this method will trigger a new “HERE Traffic” transaction, for example, if you are using the Base Plan.

Declaration

Swift

public func calculateTrafficOnRoute(route: Route, lastTraveledSectionIndex: Int32, traveledDistanceOnLastSectionInMeters: Int32, completion: @escaping CalculateTrafficOnRouteCompletionHandler) -> TaskHandle

Parameters

`route`	A `Route` calculated using the online routing engine. Its `RouteHandle` and the original route calculation options will be used to compute the traffic on the route. The original route remains untouched.
`lastTraveledSectionIndex`	Indicates the index of the last traveled route section. Traveled part of the route won’t be reused.
`traveledDistanceOnLastSectionInMeters`	Offset, in meters, to the last visited position on the route section defined by the last traveled section index.
`completion`	Callback object that will be invoked after route traffic has been calculated. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    calculateTrafficOnRoute(route:lastTraveledSectionIndex:traveledDistanceOnLastSectionInMeters:currentChargeInKilowattHours:completion:)

Asynchronously calculates the traffic along an EV car route starting from the index of the last traveled route section and an offset in meters from the last visited position on the section. The field TrafficOnSpan.consumptionInKilowattHours will contain the power consumption in kilowatt-hours (kWh) necessary to traverse the span, and RoutePlace.chargeInKilowattHours, inside TrafficOnSection.departurePlace and TrafficOnSection.arrivalPlace, the estimated battery charge in kilowatt-hours (kWh) when leaving/arriving to a section. Note: Only EV cars are supported.

Declaration

Swift

public func calculateTrafficOnRoute(route: Route, lastTraveledSectionIndex: Int32, traveledDistanceOnLastSectionInMeters: Int32, currentChargeInKilowattHours: Double, completion: @escaping CalculateTrafficOnRouteCompletionHandler) -> TaskHandle

Parameters

`route`	A `Route` calculated using the online routing engine. Its `RouteHandle` and the original route calculation options, along with EV related information like `BatterySpecifications`, will be used to compute the traffic on the route. The original route remains untouched.
`lastTraveledSectionIndex`	Indicates the index of the last traveled route section. Traveled part of the route won’t be reused.
`traveledDistanceOnLastSectionInMeters`	Offset, in meters, to the last visited position on the route section defined by the last traveled section index.
`currentChargeInKilowattHours`	Charge level of the vehicle’s battery at the current location (in kWh). It must be non-negative and less than or equal to the value of `BatterySpecifications.totalCapacityInKilowattHours`, otherwise the `BatterySpecifications` instance is considered invalid. Sets `BatterySpecifications.initialChargeInKilowattHours` to the given value.
`completion`	Callback object that will be invoked after route traffic has been calculated. It is always invoked on the main thread.

Return Value

Handle that will be used to manipulate the execution of the task.


                    
                    
                    setCustomOption(name:value:)

Sets a custom option for routing backend queries. The custom option is applied to all the queries that RoutingEngine performs. For a complete list of available parameter names and their valid values, refer to HERE Routing API v8. Note: It’s easy to set a wrong option that makes queries invalid, so make sure you read and understand the backend documentation.

Declaration

Swift

public func setCustomOption(name: String, value: String?) -> RoutingError?

Parameters

`name`	An option name. If the engine already has an option with the same name, the option will be overwritten. The option name must be a non-empty string.
`value`	An option value. If the value is `nil`, the option will be removed. The option value must be a non-empty string.

Return Value

An optional error of setting the option. It’s nil if the option has been set successfully. It’s RoutingError.INVALID_PARAMETER if the input name and/or value haven’t passed internal validation.