Builder

class Builder(    query: String,     route: List<GeoCoordinate>,     maxDetourTime: Duration)

Builder used to create an immutable instance of the AlongRouteSearchOptions.

Parameters

query

The search query.

maxDetourTime

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

Constructors

Link copied to clipboard
fun Builder(    query: String,     route: List<GeoCoordinate>,     maxDetourTime: Duration)

Functions

Link copied to clipboard
fun brandSet(brandSet: Set<String>): AlongRouteSearchOptions.Builder

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

Link copied to clipboard
fun build(): AlongRouteSearchOptions

Construct a new AlongRouteSearchOptions.

Link copied to clipboard
fun categorySet(categorySet: Set<Long>): AlongRouteSearchOptions.Builder

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

Link copied to clipboard
fun connectorSet(connectorSet: Set<String>): AlongRouteSearchOptions.Builder

A set 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.

Link copied to clipboard
fun detourOffset(detourOffset: Boolean): AlongRouteSearchOptions.Builder

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

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

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

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

Defines what kind of geopolitical view should be used.

Link copied to clipboard
fun limit(limit: Int): AlongRouteSearchOptions.Builder

The maximum number of search results that will be returned.

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

A set of MapCodeTypes which will be supported.

Link copied to clipboard
fun maxDetourTime(maxDetourTime: Duration): AlongRouteSearchOptions.Builder

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

Link copied to clipboard
fun maxPowerKw(maxPowerKw: Double): AlongRouteSearchOptions.Builder

A power rate in kilowatts, used to restrict results to electric vehicle stations with at least one connector that supports that maximum power level.

Link copied to clipboard
fun minPowerKw(minPowerKw: Double): AlongRouteSearchOptions.Builder

A power rate in kilowatts, used to restrict results to electric vehicle stations with at least one connector that supports that minimum power level.

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

Scope of the opening hours to be provided.

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

The search query.

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

A RequestedPoiRelationType that specifies what kinds of related POIs to return.

Link copied to clipboard
fun route(route: List<GeoCoordinate>): AlongRouteSearchOptions.Builder

The list of route points.

Link copied to clipboard
fun sortBy(sortBy: SortBy): AlongRouteSearchOptions.Builder

Specifies how the results will be sorted.

Link copied to clipboard
fun spreadingMode(spreadingMode: SpreadingMode): AlongRouteSearchOptions.Builder

Enables the spreading of returned results evenly along the route.

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

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

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

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