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

GuidanceOptions

@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.

Parameters

language

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

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.

phoneticsType

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

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.