com.tomtom.sdk.maps.visualization:search/com.tomtom.sdk.map.display.visualization.search/SearchConfiguration

SearchConfiguration

class SearchConfiguration(val categories: Set<CategoryId> = DEFAULT_POI_CATEGORIES, val detourTime: Duration = DEFAULT_DETOUR_TIME, val numberOfResults: Int = DEFAULT_NUMBER_OF_RESULTS, val minPower: Power? = null, val maxPower: Power? = null, val engineType: EngineType? = null, val openingHoursMode: OpeningHoursMode? = null)

These configuration parameters are used to execute a Point of Interest (Poi) search.

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

Constructors

SearchConfiguration

constructor(categories: Set<CategoryId> = DEFAULT_POI_CATEGORIES, detourTime: Duration = DEFAULT_DETOUR_TIME, numberOfResults: Int = DEFAULT_NUMBER_OF_RESULTS, minPower: Power? = null, maxPower: Power? = null, engineType: EngineType? = null, openingHoursMode: OpeningHoursMode? = null)

Types

object Companion

Properties

val categories: Set<CategoryId>

A set of POI categories used for the search. Default categories include places commonly researched, like restaurants, parking areas, and hotels.

val detourTime: Duration

The maximum allowed detour time for a Poi. Defaults to 15 minutes

val engineType: EngineType? = null

Specifies the engine type for vehicles to filter POIs based on vehicle type. If EngineType.Electric is selected, it restricts the results to Points Of Interest of type Electric Vehicle Station. supporting the specified EngineType.Electric.connectors. If EngineType.Combustion is selected, it restricts the results to Points Of Interest with the specified EngineType.Combustion.fuelTypes. If not provided, no engine-type filter is applied.

val maxPower: Power? = null

A power rate, used to restrict the results to electric vehicle stations with at least one connector that has a power lesser or equal to that maximum power. If not provided, no maximum power filter is applied.

val minPower: Power? = null

A power rate, used to restrict the results to electric vehicle stations with at least one connector that has a power greater or equal to that minimum power. If not provided, no minimum power filter is applied.

numberOfResults

val numberOfResults: Int

The maximum number of POIs to retrieve. Defaults to 20.

openingHoursMode

val openingHoursMode: OpeningHoursMode? = null