search:search-client-api/com.tomtom.sdk.search.client.alongroute/AlongRouteSearchOptions

AlongRouteSearchOptions

data class AlongRouteSearchOptions( val query: String, val route: List<GeoCoordinate>, val maxDetourTime: Duration, val typeAhead: Boolean? = null, val limit: Int? = null, val categorySet: Set<Long> = emptySet(), val brandSet: Set<String> = emptySet(), val connectorSet: Set<String> = emptySet(), val minPowerKw: Double? = null, val maxPowerKw: Double? = null, val fuelSet: Set<FuelType> = emptySet(), val geopoliticalView: String? = null, val detourOffset: Boolean? = null, val sortBy: SortBy? = null, val openingHours: OpeningHoursMode? = null, val spreadingMode: SpreadingMode? = null, val mapCodes: Set<MapCodeType> = emptySet(), val relatedPois: RequestedPoiRelationType? = null)

Defines the parameters of a Search Along the Route query.

Parameters

query

The search query.

route

The route points.

maxDetourTime

The maximum detour time. The maximum value is 3600 seconds.

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.

categorySet

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

brandSet

A list of brand names used to restrict the result to POIs associated with those brands.

connectorSet

A list of connector types used to restrict the results to electric vehicle stations that support those 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 results to electric vehicle stations with at least one connector with that minimum power.

maxPowerKw

A double value representing a power rate in kilowatts, used the results to electric vehicle stations with at least one connector with that maximum power.

fuelSet

A set of FuelTypes, used to restrict the results to ones with specific fuels.

geopoliticalView

Defines what kind of geopolitical view should be used.

detourOffset

Parameter which turns on calculation of the distance between the start of the route and the starting point of the detour to a POI.

sortBy

Defines how the results will be sorted.

openingHours

Scope of the opening hours to be provided.

spreadingMode

Defines the spreading of returned results along the route.

mapCodes

The set of MapCodeTypes which will be supported.

relatedPois

Uses the RequestedPoiRelationType to specify what kinds of related POIs to return. Points Of Interest.

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

Constructors

AlongRouteSearchOptions

fun AlongRouteSearchOptions( query: String, route: List<GeoCoordinate>, maxDetourTime: Duration, typeAhead: Boolean? = null, limit: Int? = null, categorySet: Set<Long> = emptySet(), brandSet: Set<String> = emptySet(), connectorSet: Set<String> = emptySet(), minPowerKw: Double? = null, maxPowerKw: Double? = null, fuelSet: Set<FuelType> = emptySet(), geopoliticalView: String? = null, detourOffset: Boolean? = null, sortBy: SortBy? = null, openingHours: OpeningHoursMode? = null, spreadingMode: SpreadingMode? = null, mapCodes: Set<MapCodeType> = emptySet(), relatedPois: RequestedPoiRelationType? = null)