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

AlongRouteSearchOptions

data class AlongRouteSearchOptions( val route: List<GeoCoordinate>, @IntRange(from = 1, to = 3600) val maxDetourTimeSeconds: Int, val query: String = "", @IntRange(from = 1, to = 20) val limit: Int = 10, val categorySet: Set<CategoryId> = emptySet(), val brandSet: Set<Brand> = emptySet(), val connectorSet: Set<ConnectorType> = emptySet(), val minPowerKw: Double? = null, val maxPowerKw: Double? = null, val fuelSet: Set<FuelType> = emptySet(), val geoPoliticalView: GeoPoliticalView? = null, val fetchDetourOffset: Boolean = false, val sortBy: SortBy = SortBy.DetourTime, val openingHours: OpeningHoursMode = OpeningHoursMode.NextSevenDays, val sessionId: String = "")

Defines the parameters of a Search Along the Route query.

Parameters

query

The search query.

route

The route points.

maxDetourTimeSeconds

The maximum detour time. The maximum value is 3600 seconds. Detour time is the time added to the estimated time of arrival at the destination because of the change of route.

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 fuel types.

geoPoliticalView

Defines what kind of geopolitical view should be used.

fetchDetourOffset

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.

sessionId

A search session is a user session during which a user performs multiple search requests to find a specific address or point of interest. This is needed for sending feedback to the online search.

Constructors

AlongRouteSearchOptions

fun AlongRouteSearchOptions( route: List<GeoCoordinate>, @IntRange(from = 1, to = 3600) maxDetourTimeSeconds: Int, query: String = "", @IntRange(from = 1, to = 20) limit: Int = 10, categorySet: Set<CategoryId> = emptySet(), brandSet: Set<Brand> = emptySet(), connectorSet: Set<ConnectorType> = emptySet(), minPowerKw: Double? = null, maxPowerKw: Double? = null, fuelSet: Set<FuelType> = emptySet(), geoPoliticalView: GeoPoliticalView? = null, fetchDetourOffset: Boolean = false, sortBy: SortBy = SortBy.DetourTime, openingHours: OpeningHoursMode = OpeningHoursMode.NextSevenDays, sessionId: String = "")