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: GeoGeometry? = 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.

Parameters

place

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

navigablePosition

Position of the result.

roadUse

List of road usage types at the place.

matchType

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

mapCodes

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

geometry

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).

routeNumbers

The codes used to unambiguously identify the street.

speedLimit

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).

boundingBox

The bounding box of the place match.

Constructors

PlaceMatch

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