Package com.here.sdk.routing

Class RouteHandle

java.lang.Object
com.here.sdk.routing.RouteHandle
public final class RouteHandle extends Object

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.getRouteHandle() 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.INCOMPATIBLE_ROUTE_HANDLE. See source.

  • Field Details

    • handle

      @NonNull public String handle

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

    • source

      @Nullable public RoutingEngineSource source

      The routing engine that created this handle. If it cannot be determined, the value is null, 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.

  • Constructor Details

    • RouteHandle

      public RouteHandle(@NonNull String handle)

      Creates a new instance.

      Parameters:
      handle -

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

  • Method Details