CarSetOperationStatusCallback

Artifact: androidx.car.app:app

View Source

Added in 1.3.0

---

Kotlin |Java

@CarProtocol
@RequiresCarApi(value = 5)
@ExperimentalCarApi
interface CarSetOperationStatusCallback

---

A callback for status being returned from the car hardware after completing the associated set operation.

Summary

Constants
const Int	OPERATION_STATUS_FEATURE_SETTING_NOT_ALLOWED = 4 The feature is read-only feature in the vehicle.
const Int	OPERATION_STATUS_FEATURE_TEMPORARILY_UNAVAILABLE = 3 The feature is temporarily unavailable in the specified zone.
const Int	OPERATION_STATUS_FEATURE_UNIMPLEMENTED = 1 The feature is not implemented in this vehicle.
const Int	OPERATION_STATUS_FEATURE_UNSUPPORTED = 2 The feature is not supported in this zones.
const Int	OPERATION_STATUS_ILLEGAL_CAR_HARDWARE_STATE = 7 The car returned an invalid value that cannot be interpreted.
const Int	OPERATION_STATUS_INSUFFICIENT_PERMISSION = 6 The feature is writeable in the car, but the application does not have sufficient Android-level permission to associated it.
const Int	OPERATION_STATUS_SUCCESS = 0 Set operation succeeded.
const Int	OPERATION_STATUS_UNSUPPORTED_VALUE = 5 The caller-provided value is not one of the supported values.
const Int	OPERATION_STATUS_UPDATE_TIMEOUT = 8 Failed to update to desired value in a zone within the allotted time.

Public functions
Unit	onSetCarClimateStateCabinTemperature(statusCode: Int) Notifies that set operation for FEATURE_CABIN_TEMPERATURE succeeded or failed.
Unit	onSetCarClimateStateDefroster(statusCode: Int) Notifies that set operation for FEATURE_HVAC_DEFROSTER succeeded or failed.
Unit	onSetCarClimateStateElectricDefroster(statusCode: Int) Notifies that set operation for FEATURE_HVAC_ELECTRIC_DEFROSTER succeeded or failed.
Unit	onSetCarClimateStateFanDirection(statusCode: Int) Notifies that set operation for FEATURE_FAN_DIRECTION succeeded or failed.
Unit	onSetCarClimateStateFanSpeedLevel(statusCode: Int) Notifies that set operation for FEATURE_FAN_SPEED succeeded or failed.
Unit	onSetCarClimateStateHvacAc(statusCode: Int) Notifies that set operation for FEATURE_HVAC_AC succeeded or failed.
Unit	onSetCarClimateStateHvacAutoMode(statusCode: Int) Notifies that set operation for FEATURE_HVAC_AUTO_MODE succeeded or failed.
Unit	onSetCarClimateStateHvacAutoRecirculation(statusCode: Int) Notifies that set operation for FEATURE_HVAC_AUTO_RECIRCULATION succeeded or failed.
Unit	onSetCarClimateStateHvacDualMode(statusCode: Int) Notifies that set operation for FEATURE_HVAC_DUAL_MODE succeeded or failed.
Unit	onSetCarClimateStateHvacMaxAcMode(statusCode: Int) Notifies that set operation for FEATURE_HVAC_MAX_AC succeeded or failed.
Unit	onSetCarClimateStateHvacPower(statusCode: Int) Notifies that set operation for FEATURE_HVAC_POWER succeeded or failed.
Unit	onSetCarClimateStateHvacRecirculation(statusCode: Int) Notifies that set operation for FEATURE_HVAC_RECIRCULATION succeeded or failed.
Unit	onSetCarClimateStateMaxDefroster(statusCode: Int) Notifies that set operation for FEATURE_HVAC_MAX_DEFROSTER succeeded or failed.
Unit	onSetCarClimateStateSeatTemperatureLevel(statusCode: Int) Notifies that set operation for FEATURE_SEAT_TEMPERATURE_LEVEL succeeded or failed.
Unit	onSetCarClimateStateSeatVentilationLevel(statusCode: Int) Notifies that set operation for FEATURE_SEAT_VENTILATION_LEVEL succeeded or failed.
Unit	onSetCarClimateStateSteeringWheelHeat(statusCode: Int) Notifies that set operation for FEATURE_STEERING_WHEEL_HEAT succeeded or failed.
java-static String	toString(statusCode: Int) Returns a human readable string value for the status code.

Constants

OPERATION_STATUS_FEATURE_SETTING_NOT_ALLOWED

Added in 1.3.0

const val OPERATION_STATUS_FEATURE_SETTING_NOT_ALLOWED = 4: Int

The feature is read-only feature in the vehicle.

OPERATION_STATUS_FEATURE_TEMPORARILY_UNAVAILABLE

Added in 1.3.0

const val OPERATION_STATUS_FEATURE_TEMPORARILY_UNAVAILABLE = 3: Int

The feature is temporarily unavailable in the specified zone.

For example, if applications try to open the car door when the car is moving, they might get this status code.

OPERATION_STATUS_FEATURE_UNIMPLEMENTED

Added in 1.3.0

const val OPERATION_STATUS_FEATURE_UNIMPLEMENTED = 1: Int

The feature is not implemented in this vehicle.

For example, if applications try to turn on the electric defroster in the car without this feature, they will get this status code.

OPERATION_STATUS_FEATURE_UNSUPPORTED

Added in 1.3.0

const val OPERATION_STATUS_FEATURE_UNSUPPORTED = 2: Int

The feature is not supported in this zones.

For example, if applications try to turn on the electric defroster for the front window, but the car only has the electric defroster for the rear window, they will get this status code.

OPERATION_STATUS_ILLEGAL_CAR_HARDWARE_STATE

Added in 1.3.0

const val OPERATION_STATUS_ILLEGAL_CAR_HARDWARE_STATE = 7: Int

The car returned an invalid value that cannot be interpreted.

OPERATION_STATUS_INSUFFICIENT_PERMISSION

Added in 1.3.0

const val OPERATION_STATUS_INSUFFICIENT_PERMISSION = 6: Int

The feature is writeable in the car, but the application does not have sufficient Android-level permission to associated it.

OPERATION_STATUS_SUCCESS

Added in 1.3.0

const val OPERATION_STATUS_SUCCESS = 0: Int

Set operation succeeded.

OPERATION_STATUS_UNSUPPORTED_VALUE

Added in 1.3.0

const val OPERATION_STATUS_UNSUPPORTED_VALUE = 5: Int

The caller-provided value is not one of the supported values.

For example, if the car only support seat heating levels as 0, 1, 2. In this case, when the application set seat heating level as 3, it will get this status code.

OPERATION_STATUS_UPDATE_TIMEOUT

Added in 1.3.0

const val OPERATION_STATUS_UPDATE_TIMEOUT = 8: Int

Failed to update to desired value in a zone within the allotted time.

Public functions

onSetCarClimateStateCabinTemperature

Added in 1.3.0

fun onSetCarClimateStateCabinTemperature(statusCode: Int): Unit

Notifies that set operation for FEATURE_CABIN_TEMPERATURE succeeded or failed.

Parameters
statusCode: Int	one of status codes in StatusCode

onSetCarClimateStateDefroster

Added in 1.3.0

fun onSetCarClimateStateDefroster(statusCode: Int): Unit

Notifies that set operation for FEATURE_HVAC_DEFROSTER succeeded or failed.

Parameters
statusCode: Int	one of status codes in StatusCode

onSetCarClimateStateElectricDefroster

Added in 1.3.0

fun onSetCarClimateStateElectricDefroster(statusCode: Int): Unit

Notifies that set operation for FEATURE_HVAC_ELECTRIC_DEFROSTER succeeded or failed.

Parameters
statusCode: Int	one of status codes in StatusCode

onSetCarClimateStateFanDirection

Added in 1.3.0

fun onSetCarClimateStateFanDirection(statusCode: Int): Unit

Notifies that set operation for FEATURE_FAN_DIRECTION succeeded or failed.

Parameters
statusCode: Int	one of status codes in StatusCode

onSetCarClimateStateFanSpeedLevel

Added in 1.3.0

fun onSetCarClimateStateFanSpeedLevel(statusCode: Int): Unit

Notifies that set operation for FEATURE_FAN_SPEED succeeded or failed.

Parameters
statusCode: Int	one of status codes in StatusCode

onSetCarClimateStateHvacAc

Added in 1.3.0

fun onSetCarClimateStateHvacAc(statusCode: Int): Unit

Notifies that set operation for FEATURE_HVAC_AC succeeded or failed.

Parameters
statusCode: Int	one of status codes in StatusCode

onSetCarClimateStateHvacAutoMode

Added in 1.3.0

fun onSetCarClimateStateHvacAutoMode(statusCode: Int): Unit

Notifies that set operation for FEATURE_HVAC_AUTO_MODE succeeded or failed.

Parameters
statusCode: Int	one of status codes in StatusCode

onSetCarClimateStateHvacAutoRecirculation

Added in 1.3.0

fun onSetCarClimateStateHvacAutoRecirculation(statusCode: Int): Unit

Notifies that set operation for FEATURE_HVAC_AUTO_RECIRCULATION succeeded or failed.

Parameters
statusCode: Int	one of status codes in StatusCode

onSetCarClimateStateHvacDualMode

Added in 1.3.0

fun onSetCarClimateStateHvacDualMode(statusCode: Int): Unit

Notifies that set operation for FEATURE_HVAC_DUAL_MODE succeeded or failed.

Parameters
statusCode: Int	one of status codes in StatusCode

onSetCarClimateStateHvacMaxAcMode

Added in 1.3.0

fun onSetCarClimateStateHvacMaxAcMode(statusCode: Int): Unit

Notifies that set operation for FEATURE_HVAC_MAX_AC succeeded or failed.

Parameters
statusCode: Int	one of status codes in StatusCode

onSetCarClimateStateHvacPower

Added in 1.3.0

fun onSetCarClimateStateHvacPower(statusCode: Int): Unit

Notifies that set operation for FEATURE_HVAC_POWER succeeded or failed.

Parameters
statusCode: Int	one of status codes in StatusCode

onSetCarClimateStateHvacRecirculation

Added in 1.3.0

fun onSetCarClimateStateHvacRecirculation(statusCode: Int): Unit

Notifies that set operation for FEATURE_HVAC_RECIRCULATION succeeded or failed.

Parameters
statusCode: Int	one of status codes in StatusCode

onSetCarClimateStateMaxDefroster

Added in 1.3.0

fun onSetCarClimateStateMaxDefroster(statusCode: Int): Unit

Notifies that set operation for FEATURE_HVAC_MAX_DEFROSTER succeeded or failed.

Parameters
statusCode: Int	one of status codes in StatusCode

onSetCarClimateStateSeatTemperatureLevel

Added in 1.3.0

fun onSetCarClimateStateSeatTemperatureLevel(statusCode: Int): Unit

Notifies that set operation for FEATURE_SEAT_TEMPERATURE_LEVEL succeeded or failed.

Parameters
statusCode: Int	one of status codes in StatusCode

onSetCarClimateStateSeatVentilationLevel

Added in 1.3.0

fun onSetCarClimateStateSeatVentilationLevel(statusCode: Int): Unit

Notifies that set operation for FEATURE_SEAT_VENTILATION_LEVEL succeeded or failed.

Parameters
statusCode: Int	one of status codes in StatusCode

onSetCarClimateStateSteeringWheelHeat

Added in 1.3.0

fun onSetCarClimateStateSteeringWheelHeat(statusCode: Int): Unit

Notifies that set operation for FEATURE_STEERING_WHEEL_HEAT succeeded or failed.

Parameters
statusCode: Int	one of status codes in StatusCode

toString

Added in 1.3.0

java-static fun toString(statusCode: Int): String

Returns a human readable string value for the status code.

Parameters
statusCode: Int	one of status codes in StatusCode

Throws
java.lang.IllegalArgumentException	if status code is not in StatusCode