com.tomtom.sdk.search:search/com.tomtom.sdk.search.ev/EvSearchOptions

EvSearchOptions

Defines the parameters of an Electric Vehicle (EV) Search, used for EvSearchResult filtering.

Note: The filtering is applied to an ChargingStation (charging station) or EvSearchResult (charging park).

This means that setting parameters such as status, minPower nad maxPower will filter the charging stations based on these attributes, while setting accessTypes will filter the charging park based on the access types that were provided.

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

Constructors

EvSearchOptions

constructor(geoBias: GeoPoint, radius: Distance = DEFAULT_RADIUS, @IntRange(from = 1, to = 100) limit: Int = DEFAULT_LIMIT, connectors: List<ConnectorType> = emptyList(), status: Status? = null, minPower: Power? = null, maxPower: Power? = null, accessTypes: List<AccessType> = emptyList(), locale: Locale = Locale.getDefault())

constructor(route: List<GeoPoint>, maxDetourDuration: Duration = MAX_DETOUR_UPPER_LIMIT, @IntRange(from = 1, to = 20) limit: Int = DEFAULT_LIMIT, connectors: List<ConnectorType> = emptyList(), status: Status? = null, minPower: Power? = null, maxPower: Power? = null, accessTypes: List<AccessType> = emptyList(), locale: Locale = Locale.getDefault())

Initializes the EV Search options along a specified route with additional parameters. This constructor is useful for defining searches that are constrained along a route, such as finding points of interest along the remaining part of a journey.

Types

Companion

object Companion

Properties

accessTypes

val accessTypes: List<AccessType>

A list of AccessTypes used to restrict the results to the charging stations that have at least one of the specified access types. This does not guarantee that all charging parks will have the same accessTypes.

connectors

val connectors: List<ConnectorType>

A list of ConnectorTypes used to restrict the results to the stations that have at least one connector of the specified type.

geoBias

val geoBias: GeoPoint?

The coordinate where the EV results are biased.

limit

val limit: Int

The maximum number of EvSearchResults that will be returned. Defaults to DEFAULT_LIMIT. Minimum limit accepted is MIN_LIMIT, while maximum limit accepted is MAX_LIMIT_NEARBY.

locale

val locale: Locale

The language in which search results should be returned. If not specified, language is set to the system default language.

maxDetourDuration

val maxDetourDuration: Duration?

The maximum detour duration from the route.

maxPower

val maxPower: Power?

A power rate, used to restrict the results to ChargingStations with at least one connector that has a power lesser or equal to this maximum power.

minPower

val minPower: Power?

A power rate, used to restrict the results to ChargingStations with at least one connector that has a power greater or equal to this minimum power.

radius

val radius: Distance?

The maximum distance from the specified geoBias for which the EV Search delivers results. Defaults to DEFAULT_RADIUS. Minimum radius accepted is MIN_RADIUS, while maximum radius accepted is MAX_RADIUS.

route

val route: List<GeoPoint>

The route along which the search is constrained.

status

val status: Status?

The Status to filter out ChargingPoints inside of a ChargingStation. Note: If the status data is available, this parameter will filter out the charging stations based on the status per given charging point. ChargingPoints for which the status data is not available will be included in the search results.

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String