RouteHandle

public struct RouteHandle : Hashable

Provides an opaque handle to the calculated Route. A handle encodes the calculated route. The route can be decoded from a handle at a later point in time as long as the service uses the same map data which was used during encoding. Note that the Route.routeHandle is provided only if RouteOptions.enableRouteHandle is set before route calculation. A RouteHandle generated by the online RoutingEngine is not compatible with the OfflineRoutingEngine. Similarly, a RouteHandle from the OfflineRoutingEngine cannot be used with the online RoutingEngine. Using an incompatible RouteHandle results in a RoutingError.incompatibleRouteHandle. See RouteHandle.source.

  • Handle value as provided by the routing engine that created this handle.

    Declaration

    Swift

    public var handle: String

  • The routing engine that created this handle. If it cannot be determined, the value is nil, for example for a handle constructed by the application or restored from data serialized by an earlier HERE SDK version. No compatibility check is performed in that case.

    Declaration

    Swift

    public var source: RoutingEngineSource?

  • Creates a new instance.

    Declaration

    Swift

    public init(handle: String, source: RoutingEngineSource? = nil)