CarValue
@CarProtocol
@RequiresCarApi(value = 3)
class CarValue<T>
A data value object returned from car hardware with associated metadata including status, timestamp, and the actual value.
| Parameters | |
|---|---|
<T> |
data type which is returned by the |
Summary
Constants |
|
|---|---|
const Int |
STATUS_SUCCESS = 1
|
const Int |
|
const Int |
|
const Int |
STATUS_UNKNOWN = 0
|
Public constructors |
|---|
|
Constructs a new instance of a |
@ExperimentalCarApiConstructs a new instance of a |
Public functions |
|
|---|---|
Boolean |
|
(Mutable)List<CarZone!> |
Returns a list of car zones associated with this |
Int |
Returns the status of this particular result such as success, unavailable, or unimplemented. |
Long |
Returns the time in milliseconds at which the event happened. |
T? |
getValue()Returns a the data value or |
Int |
hashCode() |
String |
toString() |
Constants
STATUS_UNAVAILABLE
const val STATUS_UNAVAILABLE = 3: Int
CarValue attempted for unavailable property, sensor, or action.
For example, the car hardware might not be able to return a value such as climate at the current time because the engine is off and will set the status to this value.
STATUS_UNIMPLEMENTED
const val STATUS_UNIMPLEMENTED = 2: Int
CarValue attempted for unimplemented property, sensor, or action.
For example, the car hardware might not be able to return a value such as speed or energy level and will set the status to this value.
Public constructors
CarValue
CarValue(value: T?, timestampMillis: Long, status: Int)
Constructs a new instance of a CarValue. Uses CAR_ZONE_GLOBAL as the zone for this instance.
| Parameters | |
|---|---|
value: T? |
data to be returned with the result |
timestampMillis: Long |
the time in milliseconds when the value was generated (see |
status: Int |
the status code associated with this value |
Public functions
getCarZones
@ExperimentalCarApi
fun getCarZones(): (Mutable)List<CarZone!>
Returns a list of car zones associated with this CarValue.
For a global vehicle function, the list will only contain GLOBAL_ZONE. Returns an empty list when getStatus is STATUS_UNIMPLEMENTED.
getStatus
fun getStatus(): Int
Returns the status of this particular result such as success, unavailable, or unimplemented.
getTimestampMillis
fun getTimestampMillis(): Long
Returns the time in milliseconds at which the event happened.
For a given property, sensor, or action, each new value's timestamp should be monotonically increasing using the same time base as SystemClock.elapsedRealtime().