Enumerations
The following enumerations are available globally.
-
RangeBoundaryrepresents different boundary representations. Currently it only supports polygon.See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public enum RangeBoundary
-
Represents the ‘extendedRouteRepresentation’ parameter values in a Request to the Routing API.
See moreDeclaration
Swift
public enum ExtendedRouteRepresentation : CaseIterable
-
Budget for determining maximum range which can be traveled.
See moreDeclaration
Swift
public enum Budget : CustomStringConvertible, Hashable
-
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.
See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
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
-
List of errors that can be thrown during the creation of
See moreGuidanceOptions.Declaration
Swift
public enum GuidanceOptionError : Error, Equatableextension 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.LHPandInstructionPhoneticsType.IPA, phonetic information (if it’s available) is returned in the Response. In this case all properties of the typeTextWithPhoneticswill contain theTextWithPhonetics.phoneticStringvalue.When using
InstructionPhoneticsType.nonevalue - 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.signpostDeclaration
Swift
public enum InstructionPhoneticsTypeextension InstructionPhoneticsType: Codable
-
Represents the ‘instructionsType’ parameter in a request to the Routing API.
See moreDeclaration
Swift
public enum InstructionType -
GuidanceVersiondefines the Guidance API version to be used.See moreImportant
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
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.referencethat 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
-
Represents types of sections of the route
See moreDeclaration
Swift
public enum SectionType : CaseIterable -
See moreRouteInformationModedefines how much guidance information (instructions and lane guidance) is returned with the route from the RoutePlanner.planRoute() function.Declaration
Swift
public enum RouteInformationMode
-
Represents routing options error.
See moreDeclaration
Swift
public enum RoutingOptionsError : Error, Equatableextension RoutingOptionsError: LocalizedError
Enumerations Reference