com.tomtom.sdk.search:reverse-geocoder/com.tomtom.sdk.search.reversegeocoder/ReverseGeocoderOptions

ReverseGeocoderOptions

data class ReverseGeocoderOptions(val position: GeoPoint, val heading: Angle? = null, val radius: Distance = DEFAULT_RADIUS, val roadUses: Set<RoadUse> = emptySet(), val areaTypes: Set<AreaType> = emptySet(), val locale: Locale = Locale.getDefault(), val preferClosestAccurateAddress: Boolean = false, val fetchGeometry: Boolean = false)

Defines the parameters of a Reverse Geocoding request.

Constructors

constructor(position: GeoPoint, heading: Angle? = null, radius: Distance = DEFAULT_RADIUS, roadUses: Set<RoadUse> = emptySet(), areaTypes: Set<AreaType> = emptySet(), locale: Locale = Locale.getDefault(), preferClosestAccurateAddress: Boolean = false, fetchGeometry: Boolean = false)

Types

Companion

object Companion

Properties

areaTypes

val areaTypes: Set<AreaType>

Filters results to the provided geography area types. The following parameters are ignored when areaTypes is set: heading, roadUses.

fetchGeometry

val fetchGeometry: Boolean = false

Fetches the geometry shapes for the provided reverse geocoding results. (where available)

heading

val heading: Angle? = null

The directional heading of the vehicle in degrees when it is traveling along a segment of the roadway. Zero is North, 90 is East, and so on.

locale

val locale: Locale

The language used to display the results. If not provided, the system default language is used.

position

val position: GeoPoint

The coordinate that will be translated into a human-readable address.

preferClosestAccurateAddress

val preferClosestAccurateAddress: Boolean = false

Gives the preference to the closest accurate address over the address with the closest navigable coordinates.

radius

val radius: Distance

The maximum distance from the specified position that the reverse Geocoder will search in. Defaults to DEFAULT_RADIUS.

roadUses

val roadUses: Set<RoadUse>

Filters results to roads with the intended usages.