EVSearchOptions
public struct EVSearchOptions
Defines the parameters of an Electric Vehicle (EV) search.
Important
This is a Public Preview API. It may be changed or removed at any time.EV stations with the specified access types.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public var accessTypes: Set<ChargingPark.AccessType>
A list of connector types that a charging station supports. See https://developer.tomtom.com/search-api/search-api-documentation/supported-connector-types for more details.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public var connectors: Set<ConnectorType>
The position where results should be biased.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public var geoBias: CLLocationCoordinate2D?
Creates an EVSearchOptions
to perform EV search.
Important
Some EV stations don’t support status and access type filters. Setting those filters excludes those stations from the results.Important
If one of EV stations in a charging park satisfies the search filter, all of the EV stations will be returned.Important
If dynamic datastatus
is not available to an implementation, the filter will be ignored.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public init(
geoBias: CLLocationCoordinate2D,
radius: Measurement<UnitLength> = .tt.kilometers(5),
limit: Int = 10,
locale: Locale = .current,
minPower: Measurement<UnitPower>? = nil,
maxPower: Measurement<UnitPower>? = nil,
connectors: Set<ConnectorType> = [],
status: ChargingPoint.Status? = nil,
accessTypes: Set<ChargingPark.AccessType> = []
)
Parameters
geoBias
|
The coordinates where results should be biased. |
radius
|
The maximum distance from the specified position for which the EV Search delivers results. Defaults to 5km. |
limit
|
The maximum number of search results that will be returned. Defaults to 10. |
locale
|
The language in which search results should be returned. |
minPower
|
The minimal power that a charging station can provide. |
maxPower
|
The maximal power that a charging station can provide. |
connectors
|
A list of connector types that a charging station supports. |
status
|
EV stations with this specified status. If nil, no status filter is applied. |
accessTypes
|
EV stations with the specified access types. |
Creates an EVSearchOptions
to perform EV along route search.
Important
Some EV stations don’t support status and access type filters. Setting those filters excludes those stations from the results.Important
If one of EV stations in a charging park satisfies the search filter, all of the EV stations will be returned.Important
If dynamic datastatus
is not available to an implementation, the filter will be ignored.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public init(
route: [CLLocationCoordinate2D],
maxDetourDuration: Measurement<UnitDuration> = .tt.hours(1),
limit: Int = 10,
locale: Locale = .current,
minPower: Measurement<UnitPower>? = nil,
maxPower: Measurement<UnitPower>? = nil,
connectors: Set<ConnectorType> = [],
status: ChargingPoint.Status? = nil,
accessTypes: Set<ChargingPark.AccessType> = []
)
Parameters
route
|
The route along which to search. |
maxDetourDuration
|
The maximum detour duration (for a passenger car) limits the search area. The detour duration is the value added to the estimated time of arrival (to the final destination) after a point of interest is added to the route. Search results that add more than this value are filtered out. The maximum accepted value is 1 hour. |
limit
|
The maximum number of search results that will be returned. Defaults to 10. |
locale
|
The language in which search results should be returned. |
minPower
|
The minimal power that a charging station can provide. |
maxPower
|
The maximal power that a charging station can provide. |
connectors
|
A list of connector types that a charging station supports. |
status
|
EV stations with this specified status. If nil, no status filter is applied. |
accessTypes
|
EV stations with the specified access types. |
The maximum number of search results that will be returned. Defaults to 10.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public var limit: Int
The language in which search results should be returned.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public var locale: Locale
The maximum detour duration (for a passenger car) limits the search area. The detour duration is the value added to the estimated time of arrival (to the final destination) after a point of interest is added to the route. Search results that add more than this value are filtered out. The maximum accepted value is 1 hour.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public var maxDetourDuration: Measurement<UnitDuration>?
The maximal power that a charging station can provide.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public var maxPower: Measurement<UnitPower>?
The minimal power that a charging station can provide.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public var minPower: Measurement<UnitPower>?
The maximum distance from the specified position for which the EV Search delivers results.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public var radius: Measurement<UnitLength>?
The route along which to search.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public var route: [CLLocationCoordinate2D]?
EV stations with this specified status. nil
means no status filter is applied.
Important
This is a Public Preview API. It may be changed or removed at any time.Declaration
Swift
public var status: ChargingPoint.Status?