TomTomSDKRoutingCommon

  • Defines what kind of roads should be avoided while calculating a route. The given road types can still be considered during route planning but the computed routes will only contain them if no other routes exist or if avoiding such roads would result in a large detour. Please use Route Sections to check for violations.

    See more

    Declaration

    Swift

    public enum AvoidType
  • Represents the electric vehicle options that provide charging information.

    See more

    Declaration

    Swift

    public struct ChargingOptions
  • ChargingStopsStrategy Specifies the charging stops strategy to be used by the Online Routing service.

    See more

    Declaration

    Swift

    public enum ChargingStopsStrategy
  • Determines if traffic information should be considered during routing. For example, traffic is not supposed to be used for walking routes.

    See more

    Declaration

    Swift

    public enum ConsiderTraffic
  • Criteria that specify what paths to prefer during routing.

    See more

    Declaration

    Swift

    public struct CostModel
  • Represents the desired amount of hilliness for a thrilling route.

    Note

    This parameter can only be used in conjunction with routeType=thrilling

    Note

    This option is not yet supported with the Orbis map.
    See more

    Declaration

    Swift

    public enum Hilliness
  • Represents a requested sequence of points that a route should visit.

    See more

    Declaration

    Swift

    public struct Itinerary
  • Represents a stop on the route (origin, destination or waypoint).

    See more

    Declaration

    Swift

    public struct ItineraryPoint
  • Options related to the API request.

    See more

    Declaration

    Swift

    public struct QueryOptions
  • Defines the reconstruction mode used for route reconstruction.

    Note

    This option is not yet supported with the Orbis map.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public enum ReconstructionMode
  • Specifies whether to include announcement points in instructions. Supported only in routing with extended guidance.

    Note

    This option is not supported with the Orbis map.
    See more

    Declaration

    Swift

    @available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.")
    public enum AnnouncementPoints
  • Represents the ‘instructionsType’ parameter in a request to the Routing API.

    See more

    Declaration

    Swift

    @available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.")
    public enum InstructionType
  • GuidanceVersion defines the Guidance API version to be used.

    See more

    Declaration

    Swift

    @available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.")
    public enum OnlineAPIVersion : Int
  • Specifies whether to include progress points (travel time and distance points) in the response.

    See more

    Declaration

    Swift

    public enum ProgressPoints
  • Specifies whether to include road shield references into the external road shields atlas. If this parameter is set to all, the Instructions in route response contain RoadShield.reference that refers to the road shields of the next significant road segment after the maneuver. This refrence can then be used to decide upon the correct road shield image.

    See more

    Declaration

    Swift

    public enum RoadShieldReferences
  • Specifies if a route is optimized for travel time, short path length, or other goals.

    See more

    Declaration

    Swift

    public enum RouteType : Equatable
  • Specifies in which countries toll roads that require vignettes may be taken or should be avoided.

    See more

    Declaration

    Swift

    public enum Vignettes
  • Used to decide how to optimize the order of waypoints.

    See more

    Declaration

    Swift

    public enum WaypointOptimization
  • Defines the type of ItineraryPoint.

    Important

    This is a Public Preview API. It may be changed or removed at any time.
    See more

    Declaration

    Swift

    public enum WaypointType
  • Represents routing options error.

    See more

    Declaration

    Swift

    public enum RoutingOptionsError : Error, Equatable
    extension RoutingOptionsError: LocalizedError