com.tomtom.sdk.search:dynamic-data/com.tomtom.sdk.search.dynamicdata.ev/EvChargingAvailabilityOptions

EvChargingAvailabilityOptions

data class EvChargingAvailabilityOptions(val availabilityId: EvChargingAvailabilityId, val connectors: Set<ConnectorType> = emptySet(), val minPower: Power? = null, val maxPower: Power? = null)

Defines the parameters of a request from the EvChargingAvailabilityProvider.

Usage example:

val options = searchResultId.evChargingAvailabilityId?.let { availabilityId ->
    EvChargingAvailabilityOptions(
        availabilityId = availabilityId,
        connectors = setOf(ConnectorType.Iec62196Type1Ccs, ConnectorType.Tesla),
        minPower = Power.kilowatts(10),
        maxPower = Power.kilowatts(15)
    )
}

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

Throws

IllegalArgumentException

if minPower is greater than maxPower.

Constructors

EvChargingAvailabilityOptions

constructor(availabilityId: EvChargingAvailabilityId, connectors: Set<ConnectorType> = emptySet(), minPower: Power? = null, maxPower: Power? = null)

Properties

availabilityId

val availabilityId: EvChargingAvailabilityId

The availability ID of the target charging station. Obtain the ID from the Search API by performing a search request and extracting the ID from the result, if it represents a charging station. Alternatively, retrieve it from the POI Details API by requesting the details of a charging station.

connectors

val connectors: Set<ConnectorType>

A set of connector types to restrict the results to specific availability types.

maxPower

val maxPower: Power? = null

Restricts the results to connectors with a maximum specified power. This can be used in conjunction with minPower. If not provided, there is no upper limit on the power capacity.

minPower

val minPower: Power? = null

Restricts the results to connectors with a minimum specified power. This can be used in conjunction with maxPower. If not provided, there is no lower limit on the power capacity.