Enumerations
The following enumerations are available globally.
-
Defines what kind of roads should be avoided while calculating a route.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum AvoidType : String, Codable
-
Degree of hilliness for a thrilling route. Note: This parameter can only be used in conjunction with routeType=thrilling
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum Hilliness : String
extension Hilliness: QueryItemConvertible
-
This represents the ‘routeType’ parameter in a Request to the Routing API.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum RouteType : Equatable
extension RouteType: QueryItemConvertible
-
Either of avoidVignette or allowVignette.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum Vignette
-
Used to decide how to optimize the order of waypoints.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum WaypointOptimization : String
-
Degree that the route winds in a thrilling route. Note: This parameter can only be used in conjunction with routeType=thrilling.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum Windingness : String
extension Windingness: QueryItemConvertible
-
Represents the ‘extendedRouteRepresentation’ parameter values in a Request to the Routing API.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum ExtendedRouteRepresentation : String
extension ExtendedRouteRepresentation: QueryItemConvertible
-
Budget for determining maximum range which can be traveled.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum Budget : CustomStringConvertible, Hashable
-
Specifies the representation of the set of routes provided as a response.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum RouteRepresentation : String
extension RouteRepresentation: QueryItemConvertible
-
Represents the ‘alternativeType’ parameter in a Request to the Routing API.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum AlternativeType : String
extension AlternativeType: QueryItemConvertible
-
Specifies whether to include announcement points in instructions. Supported only in routing with extended guidance.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum AnnouncementPoints : String
extension AnnouncementPoints: QueryItemConvertible
-
Specifies whether to include extended guidance sections in the response, such as road shield, lane, and speed limit sections.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum ExtendedSections
-
GuidanceVersion
defines the Guidance API version to be used.Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum GuidanceOnlineApiVersion : Int
-
List of exceptions that can be thrown during the creation of
GuidanceOptions
.Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum GuidanceOptionError : Error
-
Specifies whether to include the phonetic transcription of street names, signpost text, and road numbers in the instruction.
When using any value other than none, phonetic information will be returned in the Response as follows:
Instructions containing a [com.tomtom.sdk.common.route.Instruction.street] street field are extended with:
- [Instruction.phoneticStreet]: Phonetic string in the requested phonetic format.
- [Instruction.phoneticStreetLanguageCode]: Language code in which the phonetic string is encoded.
Instructions containing a [Instruction.signpostText] field are extended with:
- [Instruction.phoneticSignPostText]: Phonetic string in the requested phonetic format.
- [Instruction.phoneticSignPostTextLanguageCode]: Language code in which the phonetic string is encoded.
Instructions containing a [Instruction.roadNumbers] array are extended with:
- [Instruction.phoneticRoadNumbers]: Array of phonetic strings in the requested phonetic format corresponding to the respective elements of the roadNumbers array.
- [Instruction.phoneticRoadNumberLanguageCodes]: Array of language codes in which the respective phonetic strings are encoded.
Important
This is a Public Preview API. It may be changed or removed at any time.
Declaration
Swift
public enum InstructionPhoneticsType : String
extension InstructionPhoneticsType: QueryItemConvertible
extension InstructionPhoneticsType: Codable
-
Represents the ‘instructionsType’ parameter in a Request to the Routing API.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum InstructionsType : String
extension InstructionsType: QueryItemConvertible
-
Specifies whether to include progress points (travel time and distance points) in the response.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum ProgressPoints
-
Specifies whether to include road shield references into the external road shields atlas. Instructions contain [Instruction.roadShieldReferences]
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum RequestedRoadShieldReferences : String
extension RequestedRoadShieldReferences: QueryItemConvertible
-
Represents types of sections of the route
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum SectionType : String, CaseIterable
extension SectionType: QueryItemConvertible
-
RouteInformationMode
defines how much guidance information (instructions and lane guidance) is returned with the route from the RoutePlanner.planRoute() function.Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum RouteInformationMode