search:search-client-api/com.tomtom.sdk.search/SearchOptions

SearchOptions

Defines the parameters of a Search.

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

Constructors

fun SearchOptions(query: String = "", @IntRange(from = 1, to = 100) limit: Int = DEFAULT_LIMIT, maxDetourDuration: Duration? = MAX_DETOUR_DURATION_UPPER_LIMIT, countryCodes: Set<String> = emptySet(), geoBias: GeoPoint? = null, @Size(min = 0, max = 50) searchAreas: Set<Geometry> = emptySet(), locale: Locale = Locale.getDefault(), resultTypes: Set<SearchResultType> = emptySet(), categoryIds: Set<CategoryId> = emptySet(), brands: Set<Brand> = emptySet(), connectors: Set<ConnectorType> = emptySet(), minPower: Power? = null, maxPower: Power? = null, fuelTypes: Set<FuelType> = emptySet(), geoPoliticalView: GeopoliticalView? = null, openingHoursMode: OpeningHoursMode? = null, sessionId: UUID? = null)

SearchOptions

fun SearchOptions(route: List<GeoPoint>, query: String = "", @IntRange(from = 1, to = 20) limit: Int = DEFAULT_LIMIT, maxDetourDuration: Duration? = MAX_DETOUR_DURATION_UPPER_LIMIT, categoryIds: Set<CategoryId> = emptySet(), brands: Set<Brand> = emptySet(), fuelTypes: Set<FuelType> = emptySet(), connectors: Set<ConnectorType> = emptySet(), minPower: Power? = null, maxPower: Power? = null, geoPoliticalView: GeopoliticalView? = null, sortOrder: SortOrder = SortOrder.ByDetourTime, openingHoursMode: OpeningHoursMode? = null, sessionId: UUID? = null)

Types

Companion

object Companion

Properties

brands

val brands: Set<Brand>

A list of brand names (case sensitive) used to restrict the result.

categoryIds

val categoryIds: Set<CategoryId>

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

connectors

val connectors: Set<ConnectorType>

A list of connector types 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.

countryCodes

val countryCodes: Set<String>

A set of ISO 3166-1 alpha3 country codes. (e.g., FRA,ESP). This will limit the search to the specified countries.

fuelTypes

val fuelTypes: Set<FuelType>

A set of a FuelType used to restrict the result to Points Of Interest with those specific fuels.

geoBias

val geoBias: GeoPoint?

The GeoPoint position where results should be biased.

geoPoliticalView

val geoPoliticalView: GeopoliticalView?

Defines what kind of geopolitical view should be used.

limit

val limit: Int

The maximum number of search results that will be returned. Defaults to DEFAULT_LIMIT.

locale

val locale: Locale

The language in which search results should be returned. If not specified, language is set to the system default language.

maxDetourDuration

val maxDetourDuration: Duration?

The maximum detour duration (for a passenger car) limits the search area. The detour duration is the value added to the estimated time of arrival (to the final destination) after a point of interest is added to the route. Search results that add more than this value are filtered out. The maximum accepted value is 3600 seconds (which equals one hour). If a value greater than the maximum is provided, then the maximum value is used. Default duration is set to MAX_DETOUR_DURATION_UPPER_LIMIT.

maxPower

val maxPower: Power?

A power rate, used to restrict the results to electric vehicle stations with at least one connector that has a power lesser or equal to that maximum power.

minPower

val minPower: Power?

A power rate, used to restrict the results to electric vehicle stations with at least one connector that has a power greater or equal to that minimum power.

openingHoursMode

val openingHoursMode: OpeningHoursMode?

The opening hours scope. If it's not provided, no data about opening hours will be returned.

query

val query: String

The search query.

route

val route: List<GeoPoint>

The route points define the skeleton of the search area.

searchAreas

val searchAreas: Set<Geometry>

The geographic filter for search, all search results returned are confined in the specified geography. Max number of geometries is 50. Three types of geometries can be passed as searchAreas: CircleGeometry, RectangleGeometry and PolygonGeometry When a single CircleGeometry is set the CircleGeometry center overrides geoBias.

searchResultTypes

val searchResultTypes: Set<SearchResultType>

A set of SearchResultType which should be used for the search. An empty set implies search can return results of any type. Other filters can influence the selection of searchResultTypes. For example when a category filter is set, result types are limited to SearchResultType.Poi.

sessionId

val sessionId: UUID?

A search session is a user session during which a user performs multiple search requests to find a specific address ot point of interest. This is needed for sending feedback to the online search. It must be a valid UUIDv4. If it is not provided, no feedback is sent.

sortOrder

val sortOrder: SortOrder

Defines how the results will be sorted. Default value is SortOrder.ByDetourTime.