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

GuidanceOptions

class GuidanceOptions(val language: Locale = Locale.ENGLISH, val roadShieldReferences: RoadShieldReferences = RoadShieldReferences.None, val phoneticsType: InstructionPhoneticsType = InstructionPhoneticsType.Ipa, val extendedSections: ExtendedSections = ExtendedSections.None)

Specifies options related to instructions.

Constructors

Link copied to clipboard
constructor(language: Locale = Locale.ENGLISH, roadShieldReferences: RoadShieldReferences = RoadShieldReferences.None, phoneticsType: InstructionPhoneticsType = InstructionPhoneticsType.Ipa, extendedSections: ExtendedSections = ExtendedSections.None)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val extendedSections: ExtendedSections

Whether to include road shield sections and lane sections in the returned com.tomtom.sdk.routing.route.Route.sections. com.tomtom.sdk.routing.route.section.roadshield.RoadShieldSection can be provided via this parameter even when no instructions are requested nor provided. Default value is ExtendedSections.None.

Link copied to clipboard
val language: Locale

The language of instructions. Default value is Locale.ENGLISH.

Link copied to clipboard
val phoneticsType: InstructionPhoneticsType

The format of instruction phonetic transcriptions. Default value is InstructionPhoneticsType.Ipa.

Link copied to clipboard
val roadShieldReferences: RoadShieldReferences

Whether to include references to road shields in instructions. Default value is RoadShieldReferences.None. This properties value will be ignored when using the Orbis endpoint as it only supports RoadShieldReferences.All

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean

Checks whether this GuidanceOptions object is structurally equal to another object.

Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String