sdk-search / com.tomtom.online.sdk.search.data.fuzzy / FuzzySearchResult

FuzzySearchResult

open class FuzzySearchResult : Serializable

The result of a Search query.

Constructors

<init>

FuzzySearchResult()

Empty constructor for the FuzzySearchResult.

FuzzySearchResult(type: String!, id: String!, score: Double, address: Address!, position: LatLng!, viewport: BoundingBox!, distance: Double, info: String!, entityType: String!, poi: Poi!, boundingBox: BoundingBox!, entryPoints: Array<EntryPoint!>!, addressRanges: AddressRanges!, additionalDataSources: AdditionalDataSources!, mapCodes: Array<MapCode!>!, relatedPois: Array<RelatedPoi!>!)

Default constructor for the FuzzySearchResult.

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!

The detailed address of the result.

addressRanges

var addressRanges: AddressRanges!

Address ranges on a street segment. Only available for results where the result type is equal to "Address Range".

boundingBox

var boundingBox: BoundingBox!

An rectangle into which the shape of an administrative area is inscribed. Only available for results where the result type is equal to "Geography", and municipality information is not present.

distance

var distance: Double

The distance from the route provided in the request.

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!>!

A list of entrances to the POI.

id

var id: String!

The id of the result.

info

var info: String!

Additional info.

mapCodes

var mapCodes: Array<MapCode!>!

A list of MapCode objects.

poi

var poi: Poi!

Information about the POI.

position

var position: LatLng!

The geographical position of the POI.

relatedPois

var relatedPois: Array<RelatedPoi!>!

A list of RelatedPoi objects.

score

var score: Double

The score of the result.

type

var type: String!

The type of result (should always be "POI" (Points of Interest)).

viewport

var viewport: BoundingBox!

The viewport.

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 the detailed address of the result.

getAddressRanges

open fun getAddressRanges(): AddressRanges!

Returns the address ranges on a street segment. Only available for results where the result type is equal to "Address Range".

getBoundingBox

open fun getBoundingBox(): BoundingBox!

Returns a rectangle into which the shape of an administrative area is inscribed. Only available for results where the result type is equal to "Geography", and municipality information is not present.

getDistance

open fun getDistance(): Double

Returns the distance from the route provided in the request.

getEntityType

open fun getEntityType(): String!

Returns the type of the entity.

getEntryPoints

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

Returns a list of entrances to the POI.

getId

open fun getId(): String!

Returns the id of the result.

getInfo

open fun getInfo(): String!

Returns additional info.

getMapCodes

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

getPoi

open fun getPoi(): Poi!

Returns information about the POI.

getPosition

open fun getPosition(): LatLng!

Returns the geographical position of the POI.

getRelatedPois

open fun getRelatedPois(): ImmutableList<RelatedPoi!>!

getScore

open fun getScore(): Double

Returns the score of the result.

getType

open fun getType(): String!

Returns the type of result (should always be "POI" (Points of Interest)).

getViewport

open fun getViewport(): BoundingBox!

Returns the viewport.

toString

open fun toString(): String