Builder

class Builder(query: String, geometries: List<Geometry>)

Builder used to create an instance of GeometrySearchOptions. Once constructed, the user cannot change the field values.

Parameters

query

The searched query.

geometries

The list of geometries to search in.

Constructors

Link copied to clipboard
fun Builder(query: String, geometries: List<Geometry>)

Functions

Link copied to clipboard
fun brandSet(brandSet: Set<String>): GeometrySearchOptions.Builder

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

Link copied to clipboard
fun build(): GeometrySearchOptions

Construct a new GeometrySearchOptions.

Link copied to clipboard
fun categorySet(categorySet: Set<Long>): GeometrySearchOptions.Builder

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

Link copied to clipboard
fun connectorSet(connectorSet: Set<String>): GeometrySearchOptions.Builder

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

Link copied to clipboard
fun entityTypeSet(entityTypeSet: Set<EntityType>): GeometrySearchOptions.Builder

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

Link copied to clipboard
fun extendedPostalCodes(extendedPostalCodes: List<IndexType>): GeometrySearchOptions.Builder

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

Link copied to clipboard
fun fuelSet(fuelSet: Set<FuelType>): GeometrySearchOptions.Builder

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

Link copied to clipboard
fun geometries(geometries: List<Geometry>): GeometrySearchOptions.Builder

The list of geometries to search in.

Link copied to clipboard
fun geopoliticalView(geopoliticalView: String): GeometrySearchOptions.Builder

Defines what kind of geopolitical view should be used.

Link copied to clipboard
fun idxSet(idxSet: Set<IndexType>): GeometrySearchOptions.Builder

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

Link copied to clipboard
fun language(language: String): GeometrySearchOptions.Builder

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.

Link copied to clipboard
fun limit(limit: Int): GeometrySearchOptions.Builder

The maximum number of search results that will be returned.

Link copied to clipboard
fun mapCodes(mapCodes: Set<MapCodeType>): GeometrySearchOptions.Builder

The set of MapCodeType which will be supported.

Link copied to clipboard
fun maxPowerKW(maxPowerKW: Double): GeometrySearchOptions.Builder

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.

Link copied to clipboard
fun minPowerKW(minPowerKW: Double): GeometrySearchOptions.Builder

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.

Link copied to clipboard
fun openingHours(openingHours: OpeningHoursMode): GeometrySearchOptions.Builder

The opening hours scope.

Link copied to clipboard
fun query(query: String): GeometrySearchOptions.Builder

The searched query.

Link copied to clipboard
fun relatedPois(relatedPois: RequestedPoiRelationType): GeometrySearchOptions.Builder

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

Link copied to clipboard
fun timeZone(timeZone: TimeZoneType): GeometrySearchOptions.Builder

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