sdk-search / com.tomtom.online.sdk.search.data.geometry / GeometrySearchResult

GeometrySearchResult

open class GeometrySearchResult : Serializable

The result of a Geometry Search query.

Constructors

<init>

GeometrySearchResult()

The result of a Geometry Search query.

Properties

additionalDataSources

var additionalDataSources: AdditionalDataSources!

Information about sources of additional data that can be used with the Additional Data service. -- GETTER --

address

var address: Address!

This object contains the address information of a result. Fields availability vary depending on an administrative hierarchy of a result's country of origin and a result itself (e.g., if a result represents a country that does not have subdivision information). -- GETTER --

addressRanges

var addressRanges: AddressRanges!

Address ranges on a street segment. Available only for results where the result type is equal to "Address Range". -- GETTER --

boundingBox

var boundingBox: BoundingBox!

A rectangle into which the shape of an administrative area is inscribed. Available only for results where the result type is equal to "Geography", and municipality information is not present. -- GETTER --

distance

var distance: Double

The distance in meters from the provided starting point for a search. It is available in a Response only when the Request contains "lat" and "lon" parameters. -- GETTER --

entityType

var entityType: String!

(Only for results of type "Geography") The type of the entity. (One of "County", "CountrySubdivision", "CountrySecondarySubdivision", "CountryTeritarySubdivision", "Municipality", "MunicipalitySubdivision", "Neighborhood", "PostalCodeArea"). -- GETTER --

entryPoints

var entryPoints: Array<EntryPoint!>!

(Only for POI) Points of entry to the POI. -- GETTER --

id

var id: String!

The ID of the return result. It is not guaranteed to be stable. On the contrary, it may often change. -- GETTER --

info

var info: String!

Information about the original data source of the result. -- GETTER --

mapCodes

var mapCodes: Array<MapCode!>!

A list of MapCode objects.

poi

var poi: Poi!

This section is available when the type of the result is equal to "POI" (Points of Interest). It contains the basic properties of a POI. -- GETTER --

position

var position: LatLng!

A point representing the geographical center of a result or an address point if a result contains full address information (including a house number). -- GETTER --

score

var score: Double

The score of the result. A larger score means that the probability of a result meets a higher query criteria. -- GETTER --

type

var type: String!

The type of result. Allowed values: "Street", "Point Address", "Geography", "POI", "Cross Street", "Address Range". -- GETTER --

viewport

var viewport: BoundingBox!

A viewport which can be used to display the entity on a map. -- GETTER --

Functions

getMapCodes

open fun getMapCodes(): ImmutableList<MapCode!>!