EvSearchOptions

class EvSearchOptions(val geoBias: GeoBias, @IntRange(from = 1, to = 100) val limit: Int = DEFAULT_LIMIT, val connectors: List<ConnectorType>? = null, val status: Status? = null, val minPower: Power? = null, val maxPower: Power? = null, val accessTypes: List<AccessType>? = null, val locale: Locale = Locale.getDefault())

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

Link copied to clipboard
constructor(geoBias: GeoBias, @IntRange(from = 1, to = 100) limit: Int = DEFAULT_LIMIT, connectors: List<ConnectorType>? = null, status: Status? = null, minPower: Power? = null, maxPower: Power? = null, accessTypes: List<AccessType>? = null, locale: Locale = Locale.getDefault())

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

List of AccessTypes used for filtering out a given charging point (EvSearchResult). Note: Setting this parameter with more than one access type will return all of the charging parks that include at least one of the access types which were set. This does not guarantee that all charging parks will have the same accessTypes.

Link copied to clipboard

List of ConnectorTypes which are available in the filtered ChargingStation.

Link copied to clipboard

The GeoBias coordinate and radius where the EV results are biased. Minimum GeoBias.radius accepted is MIN_RADIUS, while maximum GeoBias.radius accepted is MAX_RADIUS.

Link copied to clipboard
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.

Link copied to clipboard

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

Link copied to clipboard
val maxPower: Power? = null

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.

Link copied to clipboard
val minPower: Power? = null

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.

Link copied to clipboard
val status: Status? = null

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

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String