GuidanceOptions
class GuidanceOptions constructor(guidanceVersion: OnlineApiVersion = OnlineApiVersion.v1, instructionType: InstructionType = InstructionType.Text, language: Locale = Locale.ENGLISH, roadShieldReferences: RoadShieldReferences = RoadShieldReferences.None, announcementPoints: AnnouncementPoints = AnnouncementPoints.None, phoneticsType: InstructionPhoneticsType = InstructionPhoneticsType.None, extendedSections: ExtendedSections = ExtendedSections.None, progressPoints: ProgressPoints = ProgressPoints.None)
Specifies options related to instructions.
Parameters
guidanceVersion
The version of the guidance API to be used.
instructionType
The format in which instructions are reported.
language
The language of instructions.
roadShieldReferences
Whether to include references to road shields in instructions.
announcementPoints
Whether to include announcement points in instructions.
phoneticsType
The format of instruction phonetic transcriptions.
extendedSections
Whether to include road shield and lane sections in the response. Note: All other section types are always included.
progressPoints
Whether to include distance and travel time points in the response.
Constructors
Link copied to clipboard
constructor(guidanceVersion: OnlineApiVersion = OnlineApiVersion.v2, language: Locale = Locale.ENGLISH, roadShieldReferences: RoadShieldReferences = RoadShieldReferences.None, phoneticsType: InstructionPhoneticsType = InstructionPhoneticsType.Ipa, extendedSections: ExtendedSections = ExtendedSections.None)
Specifies options related to instructions.
constructor(guidanceVersion: OnlineApiVersion = OnlineApiVersion.v1, instructionType: InstructionType = InstructionType.Text, language: Locale = Locale.ENGLISH, roadShieldReferences: RoadShieldReferences = RoadShieldReferences.None, announcementPoints: AnnouncementPoints = AnnouncementPoints.None, phoneticsType: InstructionPhoneticsType = InstructionPhoneticsType.None, extendedSections: ExtendedSections = ExtendedSections.None, progressPoints: ProgressPoints = ProgressPoints.None)
Properties
Functions
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
fun copy(guidanceVersion: OnlineApiVersion = this.guidanceVersion, instructionType: InstructionType = this.instructionType, language: Locale = this.language, roadShieldReferences: RoadShieldReferences = this.roadShieldReferences, announcementPoints: AnnouncementPoints = this.announcementPoints, phoneticsType: InstructionPhoneticsType = this.phoneticsType, extendedSections: ExtendedSections = this.extendedSections, progressPoints: ProgressPoints = this.progressPoints): GuidanceOptions