com.tomtom.sdk.routing:routing-common/com.tomtom.sdk.routing.options.guidance/GuidanceOptions

GuidanceOptions

class GuidanceOptions

Specifies options related to instructions.

Constructors

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
constructor(language: Locale = Locale.ENGLISH, roadShieldReferences: RoadShieldReferences = RoadShieldReferences.None, phoneticsType: InstructionPhoneticsType = InstructionPhoneticsType.Ipa, extendedSections: ExtendedSections = ExtendedSections.None)

Specifies options related to instructions.

Types

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
object Companion

Properties

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
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.

Link copied to clipboard
val language: Locale

The language of instructions.

Link copied to clipboard
val phoneticsType: InstructionPhoneticsType

The format of instruction phonetic transcriptions.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
val roadShieldReferences: RoadShieldReferences

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