TomTomSDKRoutingCommon
-
Specifies avoidance criteria.
See moreDeclaration
Swift
public struct AvoidOptions
-
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 moreDeclaration
Swift
public enum AvoidType
-
Represents the electric vehicle options that provide charging information.
See moreDeclaration
Swift
public struct ChargingOptions
-
ChargingStopsStrategy Specifies the charging stops strategy to be used by the Online Routing service.
See moreDeclaration
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 moreDeclaration
Swift
public enum ConsiderTraffic
-
Criteria that specify what paths to prefer during routing.
See moreDeclaration
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=thrillingNote
This option is not yet supported with the Orbis map.Declaration
Swift
public enum Hilliness
-
Options related to the API request.
See moreDeclaration
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.Declaration
Swift
public enum ReconstructionMode
-
Specifies options related to alternative routes.
Note
Supporting points which are used for reconstructing a route and for calculating zero or more alternative routes to this reference route is part ofRouteLegOptions
Declaration
Swift
public struct AlternativeRoutesOptions
-
Represents the ‘alternativeType’ parameter in a Request to the Routing API.
See moreDeclaration
Swift
public enum AlternativeType
-
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.Declaration
Swift
@available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.") public enum AnnouncementPoints
-
Road side on arrival preference for waypoints and destination.
See moreDeclaration
Swift
public enum ArrivalSidePreference
-
Specifies whether to include extended sections such as road shield, lane, and speed limit sections in the route response,
See moreDeclaration
Swift
public enum ExtendedSections
-
Specifies options related to generated instructions. It is used by
See moreRoutePlanningOptions
when planning a route.Declaration
Swift
public struct GuidanceOptions
-
List of errors that can be thrown during the creation of
See moreGuidanceOptions
.Declaration
Swift
public enum GuidanceOptionError : Error, Equatable
extension GuidanceOptionError: LocalizedError
-
Specifies whether to include the phonetic transcription of street names, signpost text, and road numbers in the instruction.
When using any value of
InstructionPhoneticsType.LHP
andInstructionPhoneticsType.IPA
, phonetic information (if it’s available) is returned in the Response. In this case all properties of the typeTextWithPhonetics
will contain theTextWithPhonetics.phoneticString
value.When using
InstructionPhoneticsType.none
value - no phonetic information is returned in the Response.Examples of properties of type
See moreTextWithPhonetics
: -Instruction.previousSignificantRoad.name
-Instruction.nextSignificantRoad.name
-Instruction.intersectionName
- properties ofInstruction.signpost
Declaration
-
Represents the ‘instructionsType’ parameter in a request to the Routing API.
See moreDeclaration
Swift
@available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.") public enum InstructionType
-
See moreGuidanceVersion
defines the Guidance API version to be used.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 moreDeclaration
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
See moreRoadShield.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.Declaration
Swift
public enum RoadShieldReferences
-
Specifies if a route is optimized for travel time, short path length, or other goals.
See moreDeclaration
Swift
public enum RouteType : Equatable
-
Defines the type of
ItineraryPoint
.Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum WaypointType
-
Represents the desired amount of turns for thrilling routes
Note
This parameter can only be used in conjunction with routeType=thrilling.Note
This option is not yet supported with the Orbis map.Declaration
Swift
public enum Windingness
-
See moreRouteInformationMode
defines how much guidance information (instructions and lane guidance) is returned with the route from the RoutePlanner.planRoute() function.Declaration
Swift
public enum RouteInformationMode
-
Options specific for concrete leg.
See moreDeclaration
Swift
public struct RouteLegOptions
-
Options for route planning.
See moreDeclaration
Swift
public struct RoutePlanningOptions : RoutingOptionsWithItinerary
-
Describes any errors that occur during routing.
See moreDeclaration
Swift
public struct RoutingError : LocalizedError, Equatable
-
Represents routing options error.
See moreDeclaration
Swift
public enum RoutingOptionsError : Error, Equatable
extension RoutingOptionsError: LocalizedError
-
A type that describes routing options with itinerary.
See moreDeclaration
Swift
public protocol RoutingOptionsWithItinerary