search:reverse-geocoding-client-api/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 entityTypes: Set<EntityType> = emptySet(), val locale: Locale = Locale.getDefault(), val geoPoliticalView: GeoPoliticalView? = null, val mapCodeTypes: Set<MapCodeType> = emptySet(), val preferClosestAccurateAddress: Boolean = false, val fetchGeometry: Boolean = false)

Defines the parameters of a Reverse Geocoding query.

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

Constructors

fun ReverseGeocoderOptions(position: GeoPoint, heading: Angle? = null, radius: Distance = DEFAULT_RADIUS, roadUses: Set<RoadUse> = emptySet(), entityTypes: Set<EntityType> = emptySet(), locale: Locale = Locale.getDefault(), geoPoliticalView: GeoPoliticalView? = null, mapCodeTypes: Set<MapCodeType> = emptySet(), preferClosestAccurateAddress: Boolean = false, fetchGeometry: Boolean = false)

Types

Companion

object Companion

Properties

entityTypes

val entityTypes: Set<EntityType>

This parameter specifies the level of filtering performed on geographies. Providing this parameter narrows the search to specified geography entity types. The resulting response will contain the geography ID as well as the matched entity type. This ID is a token that can be used to get the geometry of that geography. The following parameters are ignored when entityType is set: heading, roadUses

fetchGeometry

val fetchGeometry: Boolean = false

Enables the return of geometry shapes for the provided reverse geocoding results. (where available) The geometry fetching feature isn't implemented yet (this option was added for the future extension).

geoPoliticalView

val geoPoliticalView: GeoPoliticalView? = null

Defines what kind of geopolitical view should be used.

heading

val heading: Angle? = null

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

locale

val locale: Locale

The language in which reverse geocoding result should be returned. When it is not provided, it uses the system default language.

mapCodeTypes

val mapCodeTypes: Set<MapCodeType>

Enables the return of map codes. Can also filter the response to only show selected MapCodeTypes.

position

val position: GeoPoint

Coordinate that will be translated into a human-understandable street address, street element, or geography.

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 reverseGeocoder will deliver results for. Defaults to DEFAULT_RADIUS

roadUses

val roadUses: Set<RoadUse>

Restricts reverse geocoding to certain types of road uses.