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

Package com.tomtom.sdk.search.client.alongroute

Types

interface AlongRouteSearchCallback : Callback<AlongRouteSearchResponse, AlongRouteSearchError>

Callback that reports that a AlongRouteSearchResponse or AlongRouteSearchError has been received.

class AlongRouteSearchError(val message: String = "") : SearchError

Error caused by a failure while calling the Search Along the Route API. Contains information about the cause of the failure.

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.

AlongRouteSearchResponse

data class AlongRouteSearchResponse(val summary: AlongRouteSummary, val results: List<AlongRouteResult>)

Response of the Along Route Search API.