com.tomtom.sdk.routing:model/com.tomtom.sdk.routing.options.guidance/GuidanceOptions/GuidanceOptions

GuidanceOptions

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.

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

Parameters

guidanceVersion

The version of the guidance API to be used.

language

The language of instructions.

roadShieldReferences

Whether to include references to road shields 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.

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)

Deprecated

This API will be removed in the next major release. Please use the other constructor instead.

Replace with

GuidanceOptions()
Content copied to clipboard

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.