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

PlaceMatch

data class PlaceMatch(val place: Place, val navigablePosition: GeoPoint, val roadUse: Set<RoadUse> = emptySet(), val matchType: MatchType? = null, val mapCodes: Set<MapCode> = emptySet(), val geometry: Geometry? = null, val routeNumbers: List<String> = emptyList(), val speedLimit: String = "", val boundingBox: GeoBoundingBox? = null)

Describes the place details retrieved from reverse geocoding.

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

Constructors

PlaceMatch

fun PlaceMatch(place: Place, navigablePosition: GeoPoint, roadUse: Set<RoadUse> = emptySet(), matchType: MatchType? = null, mapCodes: Set<MapCode> = emptySet(), geometry: Geometry? = null, routeNumbers: List<String> = emptyList(), speedLimit: String = "", boundingBox: GeoBoundingBox? = null)

Properties

boundingBox

val boundingBox: GeoBoundingBox? = null

The bounding box of the place match.

geometry

val geometry: Geometry? = null

The geographical geometry of the place match. (where available) The value is null when ReverseGeocoderOptions.fetchGeometry is not set to true. The geometry fetching feature isn't implemented yet (this response field is reserved for the future extension).

mapCodes

val mapCodes: Set<MapCode>

The set of MapCodes for the place match. The value is null when ReverseGeocoderOptions.mapCodeTypes is null or empty.

matchType

val matchType: MatchType? = null

Information on the type of match. The value is null when ReverseGeocoderOptions.entityTypes filter is not empty.

navigablePosition

val navigablePosition: GeoPoint

Position of the result.

place

val place: Place

The result of the reverse geocoding that is matching the request.

roadUse

val roadUse: Set<RoadUse>

List of road usage types at the place.

routeNumbers

val routeNumbers: List<String>

The codes used to unambiguously identify the street.

speedLimit

val speedLimit: String

The speed limit for the street (where available) in the form DD.DDUUU, For example: 30.00KPH D is a digit (for example, 30.00). UUU is either KPH or MPH (whichever is correct for the address).