search:reverse-geocoding-client-api/com.tomtom.sdk.search.reversegeocoder

Package-level declarations

Types

ReverseGeocoder

interface ReverseGeocoder : AutoCloseable

Interface of the Reverse geocoding API for turning a location on the map into a human-readable address.

ReverseGeocoderCallback

interface ReverseGeocoderCallback : Callback<ReverseGeocoderResponse, ReverseGeocoderError>

Callback that reports that a ReverseGeocoderResponse or ReverseGeocoderError has been received.

ReverseGeocoderError

class ReverseGeocoderError(val message: String = "")

Error triggered by a failure while calling the Reverse Geocoding API. Contains information about the cause of the failure.

ReverseGeocoderOptions

data class ReverseGeocoderOptions(val position: GeoPoint, @FloatRange(from = 0.0, to = 360.0) val heading: Float? = null, @IntRange(from = 1, to = 5000) val radiusInMeters: Int = DEFAULT_RADIUS_IN_METERS, val roadUses: Set<RoadUse> = emptySet(), val entityTypes: Set<EntityType> = emptySet(), val language: String = DEFAULT_LANGUAGE, val geoPoliticalView: String = "", val mapCodeTypes: Set<MapCodeType> = emptySet(), val preferClosestAccurateAddress: Boolean = false, val fetchGeometry: Boolean = false)

Defines the parameters of a Reverse Geocoding query.

ReverseGeocoderResponse

data class ReverseGeocoderResponse(val summary: Summary, val places: List<PlaceMatch>)

Response of the Reverse Geocoding API.