sdk-search / com.tomtom.online.sdk.search.data.placebyid / PlaceByIdResult

PlaceByIdResult

open class PlaceByIdResult : Serializable

The result of a Place by Id Search query.

Constructors

<init>

PlaceByIdResult()

The result of a Place by Id Search query.

Properties

additionalDataSources

var additionalDataSources: AdditionalDataSources!

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

address

var address: Address!

Structured address for the Result. -- GETTER --

addressRanges

var addressRanges: AddressRanges!

Available only for results where the result type == "Address Range". AddressRanges object. -- GETTER --

distance

var distance: Double

Unit: meters. This is the distance to an object if geobias was provided. -- GETTER --

entityType

var entityType: String!

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

entryPoints

var entryPoints: Array<EntryPoint!>!

List of entry points of the POI. -- GETTER --

id

var id: String!

A stable unique id for the POI index, and a non-stable unique id for the other indexes. Note: Stable id means that it doesn't change between data releases without changing the location, attribution or classification. -- 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!

Optional section. Only present if type == POI. -- GETTER --

position

var position: LatLng!

Position of the Result. -- GETTER --

score

var score: Double

Score of the result. A larger score means there is a probability that a result meeting the query criteria is higher. -- GETTER --

type

var type: String!

Type of Result (one of "POI", "Street", "Geography", "Point Address", "Address Range", "Cross Street"). -- GETTER --

viewport

var viewport: BoundingBox!

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

Functions

getMapCodes

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