Builder

class Builder(query: String)

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

Parameters

query

The searched query.

Constructors

Link copied to clipboard
fun Builder(query: String)

Functions

Link copied to clipboard
fun boundingBox(boundingBox: GeoBoundingBox): FuzzySearchOptions.Builder

The GeoBoundingBox for the search.

Link copied to clipboard
fun brandSet(brandSet: List<String>): FuzzySearchOptions.Builder

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

Link copied to clipboard
fun build(): FuzzySearchOptions

Construct a new FuzzySearchOptions.

Link copied to clipboard
fun category(category: Boolean?): FuzzySearchOptions.Builder

Determines whether the Category Search is enabled.

Link copied to clipboard
fun categorySet(categorySet: List<Long>): FuzzySearchOptions.Builder

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

Link copied to clipboard
fun connectorSet(connectorSet: List<String>): FuzzySearchOptions.Builder

A list of connector types which could be used to restrict the result to Points Of Interest of type Electric Vehicle Station, supporting specific connector types. See https://developer.tomtom.com/search-api/search-api-documentation/supported-connector-types for more details.

Link copied to clipboard
fun countrySet(countries: Set<String>): FuzzySearchOptions.Builder

A set of country codes (e.g., FR,ES). This will limit the search to the specified countries.

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

A set of EntityType which will be used to restrict the result to the Geography result of a specific entity type.

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

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

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

A set of a FuelType which will be used to restrict the result to the Points Of Interest of specific fuels.

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

Defines what kind of geopolitical view should be used.

Link copied to clipboard
fun idx(idx: Set<IndexType>): FuzzySearchOptions.Builder

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

Link copied to clipboard
fun language(language: String): FuzzySearchOptions.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): FuzzySearchOptions.Builder

The maximum number of search results that will be returned.

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

The set of MapCodeTypes which will be supported.

Link copied to clipboard
fun maxFuzzyLevel(maxFuzzyLevel: Int): FuzzySearchOptions.Builder

The maximum fuzziness level to be used. The default value is 2. The maximum value is 4.

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

A double value representing the power rate in kilowatts which is used to restrict the result to the Points Of Interest of type Electric Vehicle Station supporting at least one connector with a specific maximum value of power in kilowatts.

Link copied to clipboard
fun minFuzzyLevel(minFuzzyLevel: Int): FuzzySearchOptions.Builder

The minimum fuzziness level to be used. The default value is 1. The maximum value is 4.

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

A double value representing the power rate in kilowatts which is used to restrict the result to the Points Of Interest of type Electric Vehicle Station supporting at least one connector with a specific minimal value of power in kilowatts.

Link copied to clipboard
fun offset(offset: Int): FuzzySearchOptions.Builder

The starting offset of the returned results within the full result set.

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

The opening hours scope.

Link copied to clipboard
fun position(position: GeoCoordinate): FuzzySearchOptions.Builder

The GeoCoordinate position where results should be biased.

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

The searched query.

Link copied to clipboard
fun radius(radius: Int): FuzzySearchOptions.Builder

The radius parameter is specified in meters. The results will be constrained to the defined area.

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

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

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

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

Link copied to clipboard
fun typeAhead(typeAhead: Boolean): FuzzySearchOptions.Builder

If this flag is set to true, the query will be interpreted as a partial input and the search will enter predictive mode.