search:search-client-api/com.tomtom.sdk.search.client.geometry/GeometrySearchOptions

GeometrySearchOptions

data class GeometrySearchOptions( val query: String, val geometries: List<Geometry>, val limit: Int? = null, val language: String? = null, val extendedPostalCodes: List<IndexType>, val idx: Set<IndexType>, val categorySet: Set<Long>, val brandSet: Set<String>, val connectorSet: Set<String>, val minPowerKW: Double? = null, val maxPowerKW: Double? = null, val fuelSet: Set<FuelType>, val geopoliticalView: String? = null, val openingHours: OpeningHoursMode? = null, val timeZone: TimeZoneType? = null, val mapCodes: Set<MapCodeType>, val relatedPois: RequestedPoiRelationType? = null, val entityTypeSet: Set<EntityType>)

Defines the parameters of a Geometry Search. Use GeometrySearchOptions.Builder to create a new instance of the object.

Parameters

query

The searched query.

geometries

The list of geometries to search in.

limit

The maximum number of search results that will be returned.

language

The language in which search results should be returned. Should be one of the supported IETF language tags. See https://developer.tomtom.com/search-api/search-api/supported-languages for more details.

extendedPostalCodes

Indexes for which extended postal codes should be included in the results.

idx

A set of IndexTypes which should be utilized for the search.

categorySet

Restricts the Points Of Interest in the response to those whose ID is listed.

brandSet

A list of brand names used to restrict the result to specific brands.

connectorSet

A list of connector types used to restrict the result to Electric Vehicle Station POIs that support those specific connector types. See https://developer.tomtom.com/search-api/search-api-documentation/supported-connector-types for more details.

minPowerKW

A double value representing a power rate in kilowatts, used to restrict the result to Electric Vehicle Station POIs with at least one connector with that minimum power rate.

maxPowerKW

A double value representing a power rate in kilowatts, used to restrict the result to Electric Vehicle Station POIs with at least one connector with that maximum power rate.

fuelSet

A set of FuelTypes used to restrict the result to Points Of Interest that sell specific fuels.

geopoliticalView

Defines what kind of geopolitical view should be used.

openingHours

The opening hours scope.

timeZone

Used to indicate the mode in which the time zone object should be returned.

mapCodes

The set of MapCodeType which will be supported.

relatedPois

A RequestedPoiRelationType that allows related Points Of Interest to be returned.

entityTypeSet

A set of EntityTypes used to restrict the result to Geography results of a specific entity type.

Important: This is a Public Preview API. It may be changed or removed at any time.

Constructors

GeometrySearchOptions

fun GeometrySearchOptions( query: String, geometries: List<Geometry>, limit: Int? = null, language: String? = null, extendedPostalCodes: List<IndexType>, idx: Set<IndexType>, categorySet: Set<Long>, brandSet: Set<String>, connectorSet: Set<String>, minPowerKW: Double? = null, maxPowerKW: Double? = null, fuelSet: Set<FuelType>, geopoliticalView: String? = null, openingHours: OpeningHoursMode? = null, timeZone: TimeZoneType? = null, mapCodes: Set<MapCodeType>, relatedPois: RequestedPoiRelationType? = null, entityTypeSet: Set<EntityType>)