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

Package-level declarations

Types

Link copied to clipboard
@JvmInline
value class AnnouncementPoints

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

Link copied to clipboard
@JvmInline
value class ExtendedSections

Specifies whether to include extended guidance sections in the response, such as sections of type road shield, lane, and speed limit.

Link copied to clipboard
data class GuidanceOptions(val guidanceVersion: OnlineApiVersion = OnlineApiVersion.v1, val instructionType: InstructionType = InstructionType.Text, val language: Locale = Locale.ENGLISH, val roadShieldReferences: RoadShieldReferences = RoadShieldReferences.None, val announcementPoints: AnnouncementPoints = AnnouncementPoints.None, val phoneticsType: InstructionPhoneticsType = InstructionPhoneticsType.None, val extendedSections: ExtendedSections = ExtendedSections.None, val progressPoints: ProgressPoints = ProgressPoints.None)

Specifies options related to instructions.

Link copied to clipboard
@JvmInline
value class InstructionPhoneticsType

Specifies whether to include the phonetic transcription of street names, signpost text, and road numbers in the instruction.

Link copied to clipboard
@JvmInline
value class InstructionType

Represents the 'instructionsType' parameter in a Request to the Routing API.

Link copied to clipboard
@JvmInline
value class OnlineApiVersion

Enumerates the available versions of online guidance API. Possible values are: 1: (default) Provides standard guidance features. 2: Provides improved guidance features. Not implemented yet and should not be used.

Link copied to clipboard
@JvmInline
value class ProgressPoints

Specifies whether to include progress points in a response.

Link copied to clipboard
@JvmInline
value class RoadShieldReferences

Specifies whether to include road shield references into the external road shields atlas.