sdk-search / com.tomtom.online.sdk.search.data.alongroute / IAlongRouteSearchQuery

IAlongRouteSearchQuery

interface IAlongRouteSearchQuery

AlongRouteSearchQuery is an interface designed to transfer Search API parameters in a readable manner by implementing the class: AlongRouteSearchQueryBuilder. The AlongRouteSearchQuery instance can be constructed using the associated AlongRouteSearchQueryBuilder class. Once constructed, the user cannot change the field values.

Functions

withBrandSet

abstract fun withBrandSet(brandSet: String!): IAlongRouteSearchQuery

A comma-separated list of brand names which could be used to restrict the result to Points Of Interest of specific brands.

withCategorySet

abstract fun withCategorySet(categorySet: MutableList<Long!>!): IAlongRouteSearchQuery

Restricts the results to the categories of provided POIs.

withDetourOffset

abstract fun withDetourOffset(): IAlongRouteSearchQuery

Turns on the calculation of the distance between the start of the route and the starting point of the detour to a POI. When specified, the detourOffset is present in the response.

withEVConnectorSetFilter

abstract fun withEVConnectorSetFilter(evConnectorSet: String!): IAlongRouteSearchQuery

A comma-separated list of connector types which could be used to restrict the result to Points Of Interest of type Electric Vehicle Station, supporting specific connector types.

withFuelSet

abstract fun withFuelSet(fuelSet: String!): IAlongRouteSearchQuery

A comma-separated list of fuel types which could be used to restrict the result to Points Of Interest of specific fuels.

withLimit

abstract fun withLimit(limit: Int!): IAlongRouteSearchQuery

The upper limit of the number of results.

withMapCodes

abstract fun withMapCodes(mapCodes: MutableSet<MapCodeType!>!): IAlongRouteSearchQuery

Enables the return of mapcodes.

withOpeningHours

abstract fun withOpeningHours(openingHours: OpeningHoursMode!): IAlongRouteSearchQuery

When used includes a list of opening hours for a POI (Points of Interest).

withRelatedPois

abstract fun withRelatedPois(poiRelationType: PoiRelationType!): IAlongRouteSearchQuery

Enables the return of related POIs.

withSortBy

abstract fun withSortBy(sortBy: SortBy!): IAlongRouteSearchQuery

Sorts the returned results by the provided criteria. If the method is not called, the results by default are sorted using the distance criteria.

withSpreadingMode

abstract fun withSpreadingMode(spreadingMode: SpreadingMode!): IAlongRouteSearchQuery

Enables the spreading of returned results evenly along the route.

withTimeZone

abstract fun withTimeZone(timeZone: TimeZoneType!): IAlongRouteSearchQuery

When used includes POIs' time zones.

Inheritors

AlongRouteSearchQueryBuilder

open class AlongRouteSearchQueryBuilder : IAlongRouteSearchQuery

Builder class used to create AlongRouteSearchQuery.