Enumerations

The following enumerations are available globally.

  • RangeBoundary represents different boundary representations. Currently it only supports polygon.

    Important

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

    Declaration

    Swift

    public enum RangeBoundary

ExtendedRouteRepresentation

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

    See more

    Declaration

    Swift

    public enum ExtendedRouteRepresentation : CaseIterable

Budget

  • Budget for determining maximum range which can be traveled.

    See more

    Declaration

    Swift

    public enum Budget : CustomStringConvertible, Hashable

AlternativeType

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

    See more

    Declaration

    Swift

    public enum AlternativeType

AnnouncementPoints

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

    See more

    Declaration

    Swift

    @available(*, deprecated, message: "This API is deprecated and will be removed with the next major release.")
    public enum AnnouncementPoints

ArrivalSidePreference

  • Road side on arrival preference for waypoints and destination.

    See more

    Declaration

    Swift

    public enum ArrivalSidePreference
  • Specifies whether to include extended sections such as road shield, lane, and speed limit sections in the route response,

    See more

    Declaration

    Swift

    public enum ExtendedSections

GuidanceOptionError

  • List of errors that can be thrown during the creation of GuidanceOptions.

    See more

    Declaration

    Swift

    public enum GuidanceOptionError : Error, Equatable
    extension GuidanceOptionError: LocalizedError

InstructionPhoneticsType

  • 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 and InstructionPhoneticsType.IPA, phonetic information (if it’s available) is returned in the Response. In this case all properties of the type TextWithPhonetics will contain the TextWithPhonetics.phoneticString value.

    When using InstructionPhoneticsType.none value - no phonetic information is returned in the Response.

    Examples of properties of type TextWithPhonetics: - Instruction.previousSignificantRoad.name - Instruction.nextSignificantRoad.name - Instruction.intersectionName - properties of Instruction.signpost

    See more

    Declaration

    Swift

    public enum InstructionPhoneticsType
    extension InstructionPhoneticsType: Codable

InstructionType

  • Represents the ‘instructionsType’ parameter in a request to the Routing API.

    See more

    Declaration

    Swift

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

    Declaration

    Swift

    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

RoadShieldReferences

  • 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

SectionType

  • Represents types of sections of the route

    See more

    Declaration

    Swift

    public enum SectionType : CaseIterable
  • RouteInformationMode defines how much guidance information (instructions and lane guidance) is returned with the route from the RoutePlanner.planRoute() function.

    See more

    Declaration

    Swift

    public enum RouteInformationMode