platform_evcharging_api_common_evcharging/com.tomtom.ivi.platform.evcharging.api.common.evcharging

Package-level declarations

This package contains data classes representing information relating to EV Charging.

Types

AccountInfo

@IviExperimental(reasons = [])

data class AccountInfo(val emailAddress: String? = null, val userId: String? = null) : Parcelable

Stores information related to the user's eMSP account.

AuthenticationError

enum AuthenticationError : Enum<AuthenticationError> , Parcelable

ChargingPoint

@IviExperimental(reasons = [])

data class ChargingPoint(val evseId: ChargingPointId, val evseName: ChargingPointName, val status: ChargingPointState, val connectors: List<Connector>) : Parcelable

Represents a charging point. An EVSE (Electric Vehicle Supply Equipment) is the part of a ChargingStation that will handle the charging process of one Electrical Vehicle at a time in a single session. An EVSE may have one or more Connectors but only one can be used at a time.

ChargingPointId

@IviExperimental(reasons = [])

data class ChargingPointId(val id: String) : Parcelable

ID used for uniquely identifying a particular ChargingPoint. It is not localized and should not be used for display in a production UI.

ChargingPointName

@IviExperimental(reasons = [])

data class ChargingPointName(val name: String) : Parcelable

Name of the ChargingPoint as it should be displayed to the user.

ChargingPointState

@IviExperimental(reasons = [])

enum ChargingPointState : Enum<ChargingPointState> , Parcelable

Represents the current state of a ChargingPoint.

ChargingState

@IviExperimental(reasons = [])

enum ChargingState : Enum<ChargingState> , Parcelable

Represents the state of the vehicle charging process.

ChargingStation

@IviExperimental(reasons = [])

data class ChargingStation(val id: ChargingStationId, val locationId: String, val location: Coordinate, val operatorName: String?, val chargingPoints: List<ChargingPoint>) : Parcelable

Charging station is a group of one or more EVSEs (ChargingPoint) that belong together geographically.

Connector

@IviExperimental(reasons = [])

data class Connector(val id: String, val type: VehicleEvChargingConnector) : Parcelable

Connector is a specific socket or cable available for the EV to make use of.

Cost

@IviExperimental(reasons = [])

data class Cost(val priceExcludingVat: Int, val priceIncludingVat: Int, val currency: Currency) : Parcelable

Information about the cost.

EmspAuthenticationStatus

@IviExperimental(reasons = [])

sealed class EmspAuthenticationStatus : Parcelable

The different authentication states an eMSP service can be in.

EmspIdentifier

@IviExperimental(reasons = [])

data class EmspIdentifier(val name: String) : Parcelable

A name used for uniquely identifying a particular e-Mobility Service Provider (eMSP) This is not localized and should not be used for display in a production UI.

EmspServiceInfo

@IviExperimental(reasons = [])

data class EmspServiceInfo(val emspIdentifier: EmspIdentifier, val localizedServiceName: StringResolver, val icon: DrawableResolver, val countriesOfOperation: Set<CountryId>) : Parcelable

Represents an eMSP (e-Mobility Service Provider) service.

OpenIdAuthenticationRequestInfo

@IviExperimental(reasons = [])

data class OpenIdAuthenticationRequestInfo(val authorizationRequestIntent: Intent) : Parcelable

Encapsulates an Open ID authorization request.

OpenIdAuthenticationResultInfo

@IviExperimental(reasons = [])

data class OpenIdAuthenticationResultInfo(val authorizationResultIntent: Intent) : Parcelable

Encapsulates an Open ID authorization result.

OpenIdLoginResult

@IviExperimental(reasons = [])

sealed class OpenIdLoginResult : Parcelable

An instance of one of the sealed classes deriving from this class should be used to describe the result of an Open ID login process.

Receipt

@IviExperimental(reasons = [])

data class Receipt(val consumedEnergy: Energy, val sessionCost: Cost) : Parcelable

Contains information about the completed session.

SessionInfo

@IviExperimental(reasons = [])

data class SessionInfo(val activeChargingPoint: ChargingPoint, val activeSessionId: String?, val sessionReceipt: Receipt?) : Parcelable

Contains information about the active session once the charging process has started.