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.

address

var address: Address!

Structured address for the result.

addressRanges

var addressRanges: AddressRanges!

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

distance

var distance: Double

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

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

entryPoints

var entryPoints: Array<EntryPoint!>!

List of entry points of the POI.

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.

info

var info: String!

Information about the original data source of the result.

mapCodes

var mapCodes: Array<MapCode!>!

A list of MapCode objects.

poi

var poi: Poi!

Optional section. Only present if type == POI.

position

var position: LatLng!

Position of the result.

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.

type

var type: String!

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

viewport

var viewport: BoundingBox!

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

Functions

getAdditionalDataSources

open fun getAdditionalDataSources(): AdditionalDataSources!

Returns information about the sources of additional data that can be used with the Additional Data service.

getAddress

open fun getAddress(): Address!

Returns a structured address for the result.

getAddressRanges

open fun getAddressRanges(): AddressRanges!

Returns the AddressRanges object.

getDistance

open fun getDistance(): Double

Returns the distance to an object if geobias was provided in meters.

getEntityType

open fun getEntityType(): String!

Returns the type of the entity.

getEntryPoints

open fun getEntryPoints(): Array<EntryPoint!>!

Returns a list of entry points of the POI.

getId

open fun getId(): String!

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

getInfo

open fun getInfo(): String!

Returns information about the original data source of the result.

getMapCodes

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

getPoi

open fun getPoi(): Poi!

Returns the POI if the optional section is present.

getPosition

open fun getPosition(): LatLng!

Returns the position of the result.

getScore

open fun getScore(): Double

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

getType

open fun getType(): String!

Returns the type of Result (one of "POI", "Street", "Geography", "Point Address", "Address Range", "Cross Street").

getViewport

open fun getViewport(): BoundingBox!

Returns a viewport which can be used to display the result on a map.

toString

open fun toString(): String