search:search-client-api/com.tomtom.sdk.search.client.fuzzy/FuzzySearchOptions/FuzzySearchOptions

FuzzySearchOptions

fun FuzzySearchOptions( query: String, typeAhead: Boolean? = null, @IntRange(from = 1, to = 100) limit: Int? = null, offset: Int? = null, countrySet: Set<String>, position: GeoCoordinate? = null, radius: Int? = null, boundingBox: GeoBoundingBox? = null, language: String? = null, extendedPostalCodes: List<IndexType>, minFuzzyLevel: Int? = null, maxFuzzyLevel: Int? = null, idx: Set<IndexType>, categorySet: List<Long>, brandSet: List<String>, connectorSet: List<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>, category: Boolean?)

Parameters

query

The searched query.

typeAhead

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

limit

The maximum number of search results that will be returned. Default limit is 10.

offset

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

countrySet

A set of ISO 3166-1 alpha3 country codes. (e.g., FRA, ESP). This will limit the search to the specified countries. ISO 3166-1 alpha2 country codes (e.g., FR, ES) are also supported, but only for the online search mode.

position

The GeoCoordinate position where results should be biased.

radius

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

boundingBox

The GeoBoundingBox for the search.

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.

minFuzzyLevel

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

maxFuzzyLevel

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

idx

A set of IndexType 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 which could be used to restrict the result to specific brands.

connectorSet

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.

minPowerKW

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.

maxPowerKW

fuelSet

A set of a FuelType which will be used to restrict the result to the Points Of Interest of 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 provides the possibility to return related Points Of Interest.

entityTypeSet

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