navigation-ux-ev-platform/com.mapbox.ev.client/MapboxEVSearchClientApi

MapboxEVSearchClientApi

class MapboxEVSearchClientApi(platform: MapboxEvSearch, locationCache: LocationCache<EVStation> = LocationCache())

This is the higher level client API class for interacting with the Mapbox EV search platform.

Parameters

platform

instance of MapboxEvSearch

Constructors

MapboxEVSearchClientApi

constructor(platform: MapboxEvSearch, locationCache: LocationCache<EVStation> = LocationCache())

Functions

clearSearchCacheForQuadrants

suspend fun clearSearchCacheForQuadrants(quadKeys: Set<String>)

suspend fun getEVSEbyId(locationId: String, evseId: String): Either<MapboxEVPlatformError, EVSE>

getEVStationById

suspend fun getEVStationById(locationId: String): Either<MapboxEVPlatformError, EVStation>

getLocationConnectorById

suspend fun getLocationConnectorById(locationId: String, evseId: String, connectorId: String): Either<MapboxEVPlatformError, EVSEConnector>

quickGetEVStationById

suspend fun quickGetEVStationById(evStationId: String): EVStation?

Searches the cache for a station with the specified ID

suspend fun searchChargers(points: List<Point>, options: SearchOptions): Either<MapboxEVPlatformError, List<MapboxEVSearchResult>>

suspend fun searchChargers(latitude: Double, longitude: Double, options: SearchOptions): Either<MapboxEVPlatformError, List<MapboxEVSearchResult>>

Performs a search for EV stations.

searchChargersByQuadKeys

suspend fun searchChargersByQuadKeys(quadKeys: List<String>, options: SearchOptions): Either<MapboxEVPlatformError, List<MapboxEVSearchResult>>

Performs a search for EV stations.

searchChargersInBounds

suspend fun searchChargersInBounds(northEastPoint: Point, southWestPoint: Point, options: SearchOptions): Either<MapboxEVPlatformError, List<MapboxEVSearchResult>>

searchChargersNoCache

suspend fun searchChargersNoCache(quadKeys: List<String>, options: SearchOptions): Either<MapboxEVPlatformError, List<MapboxEVSearchResult>>