Package-level declarations

Types

Link copied to clipboard
data class Announcement(    val id: UniqueId = UniqueId(),     val point: GeoPoint,     val distance: Distance,     val type: String,     val verbalMessage: String = "",     val verbalMessagePhonetics: Phonetics? = null)

Fine-grained announcement points, each with its own message, location and distance to the instruction point.

Link copied to clipboard
interface Instruction

Represents an instruction for a maneuver along the Route. In order to guide a driver along the route, the navigation system invokes guiding Instructions for every maneuver.

Link copied to clipboard
class InstructionPoint(val coordinate: GeoPoint, val routeOffset: Distance)

Represents Instruction GeoPoints together with its distance offset along the route.

Link copied to clipboard
data class Phonetics(    val street: String = "",     val streetLanguage: Locale = Locale.ENGLISH,     val roadNumbers: List<String> = emptyList(),     val roadNumbersLanguages: List<Locale> = emptyList(),     val signPostText: String = "",     val signPostTextLanguage: Locale = Locale.ENGLISH,     val phoneticAlphabet: String = "")

Phonetic strings of all of the readable Instruction properties.

Link copied to clipboard
data class PhoneticString(val value: String, val language: Locale, val alphabet: String)

Represents a phonetic string.

Link copied to clipboard
data class Road(    val name: TextWithPhonetics?,     val numbers: List<TextWithPhonetics>,     val shields: List<RoadShield>,     val types: Set<RoadType> = emptySet())

Road information at a given point on a Route.

Link copied to clipboard
data class RoadShield(    val fullRoadNumber: String,     val shieldContent: String = "",     val affixes: List<String> = emptyList(),     val stateCode: String = "",     val countryCode: String = "",     val reference: String = "")

Represents a road shield.

Link copied to clipboard
value class RoadType

Indicates a road type.

Link copied to clipboard
data class TextWithPhonetics(val plainText: String, val plainTextLanguage: Locale = Locale.ENGLISH, val phoneticString: PhoneticString? = null)

Represents a localized string with optional phonetics information.