Enumerations

The following enumerations are available globally.

ADRTunnelRestrictionCode

  • If vehicleAdrTunnelRestrictionCode is specified, the vehicle is subject to ADR tunnel restrictions.

    Important

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

    Declaration

    Swift

    public enum ADRTunnelRestrictionCode : Int, Codable
    extension ADRTunnelRestrictionCode: QueryItemConvertible

AlternativeType

  • 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.
    See more

    Declaration

    Swift

    public enum AlternativeType : String
    extension AlternativeType: QueryItemConvertible

AnnouncementPoints

  • 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.
    See more

    Declaration

    Swift

    public enum AnnouncementPoints : String
    extension AnnouncementPoints: QueryItemConvertible

AvoidTypeEnum

  • 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.
    See more

    Declaration

    Swift

    public enum AvoidTypeEnum : String

ComputeTravelTimeFor

  • Represents how much traffic information should be included in the travel time computation.

    Important

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

    Declaration

    Swift

    public enum ComputeTravelTimeFor : String
    extension ComputeTravelTimeFor: QueryItemConvertible

CoordinatePrecision

  • Represents the ‘coordinatePrecision’ parameter in a Request to the Routing API.

    Important

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

    Declaration

    Swift

    public enum CoordinatePrecision : String
    extension CoordinatePrecision: QueryItemConvertible

EngineType

  • Represents the types of the vehicle engine (e.g., electric).

    Important

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

    Declaration

    Swift

    public enum EngineType : String
    extension EngineType: QueryItemConvertible

ExtendedRouteRepresentation

  • 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

  • Possible values for FacilityType. This list may be extended in the future.

    Important

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

    Declaration

    Swift

    public enum FacilityType : Int, Codable

Hilliness

  • 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

InstructionPhoneticsType

  • 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.

    See more

    Declaration

    Swift

    public enum InstructionPhoneticsType : String
    extension InstructionPhoneticsType: QueryItemConvertible

InstructionsType

  • 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.
    See more

    Declaration

    Swift

    public enum InstructionsType : String
    extension InstructionsType: QueryItemConvertible

  • Possible values for PlugType. This list may be extended in the future.

    Important

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

    Declaration

    Swift

    public enum PlugType : Int, Codable

ReportType

  • Specifies which data should be reported for diagnosis

    Important

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

    Declaration

    Swift

    public enum ReportType : String
    extension ReportType: QueryItemConvertible

RequestedRoadShieldReferences

  • 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.
    See more

    Declaration

    Swift

    public enum RequestedRoadShieldReferences : String
    extension RequestedRoadShieldReferences: QueryItemConvertible

RouteRepresentation

  • 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

RouteType

  • The type of route requested.

    Important

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

    Declaration

    Swift

    public enum RouteType : String
    extension RouteType: QueryItemConvertible

SectionType

  • Represents types of sections of the route

    Important

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

    Declaration

    Swift

    public enum SectionType : String
    extension SectionType: QueryItemConvertible

TravelMode

  • Represents the ‘travelMode’ 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 TravelMode : String
    extension TravelMode: QueryItemConvertible

VehicleLoadType

  • Types of cargo that may be classified as hazardous materials and restricted from some roads.

    Important

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

    Declaration

    Swift

    public enum VehicleLoadType : String
    extension VehicleLoadType: QueryItemConvertible

Windingness

  • 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