routing:verbal-message-generator/com.tomtom.sdk.routing.messages.params/InstructionParams

InstructionParams

data class InstructionParams( val street: String? = null, val phoneticStreet: String? = null, val phoneticStreetLanguageCode: String? = null, val phoneticRoadNumbers: List<String> = emptyList(), val phoneticRoadNumberLanguageCodes: List<String> = emptyList(), val exitNumber: String? = null, val phoneticSignpostText: String? = null, val phoneticSignpostTextLanguageCode: String? = null, val roundaboutExitNumber: Int = 0, val isPossibleToCombineWithNext: Boolean = false, val message: String? = null, val earlyWarningAnnouncement: AnnouncementPoint? = null, val mainAnnouncement: AnnouncementPoint? = null, val confirmationAnnouncement: AnnouncementPoint? = null)

A set of Instruction attributes used for verbal messages generation.

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

Parameters

street

The street name of the next significant road segment after the maneuver, or of the street that should be followed.

phoneticStreet

Phonetic string for street. Supported only in routing with extended guidance.

phoneticStreetLanguageCode

Language code in which the phoneticStreet is encoded. Supported only in routing with extended guidance.

phoneticRoadNumbers

Phonetic string for roadNumbers. Supported only in routing with extended guidance.

phoneticRoadNumberLanguageCodes

Language code in which the phoneticRoadNumbers is encoded. Supported only in routing with extended guidance.

exitNumber

The number(s) of a highway exit taken by the current maneuver. If an exit has multiple exit numbers, they will be separated by "," and possibly aggregated by "-", e.g., "10, 13-15".

phoneticSignpostText

Phonetic string for signpostText. Supported only in routing with extended guidance.

phoneticSignpostTextLanguageCode

Language code in which the phoneticSignpostText is encoded. Supported only in routing with extended guidance.

roundaboutExitNumber

Indicates which exit to take at a roundabout.

isPossibleToCombineWithNext

It is possible to optionally combine the instruction with the next one. This can be used to build messages like "Turn left and then turn right".

message

A human-readable message for the maneuver.

earlyWarningAnnouncement

Returns fine-grained AnnouncementPoint for the Instruction located a few hundred meters before the point. Supported only in routing with extended guidance.

mainAnnouncement

Returns main fine-grained AnnouncementPoint for the Instruction. Supported only in routing with extended guidance.

confirmationAnnouncement

Returns last fine-grained AnnouncementPoint for the Instruction located tens of meters before the point. Supported only in routing with extended guidance.

Constructors

InstructionParams

fun InstructionParams( street: String? = null, phoneticStreet: String? = null, phoneticStreetLanguageCode: String? = null, phoneticRoadNumbers: List<String> = emptyList(), phoneticRoadNumberLanguageCodes: List<String> = emptyList(), exitNumber: String? = null, phoneticSignpostText: String? = null, phoneticSignpostTextLanguageCode: String? = null, roundaboutExitNumber: Int = 0, isPossibleToCombineWithNext: Boolean = false, message: String? = null, earlyWarningAnnouncement: AnnouncementPoint? = null, mainAnnouncement: AnnouncementPoint? = null, confirmationAnnouncement: AnnouncementPoint? = null)