CarSetOperationStatusCallback


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


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

Summary

Constants

default static final int

The feature is read-only feature in the vehicle.

default static final int

The feature is temporarily unavailable in the specified zone.

default static final int

The feature is not implemented in this vehicle.

default static final int

The feature is not supported in this zones.

default static final int

The car returned an invalid value that cannot be interpreted.

default static final int

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

default static final int

Set operation succeeded.

default static final int

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

default static final int

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

Public methods

default void

Notifies that set operation for FEATURE_CABIN_TEMPERATURE succeeded or failed.

default void

Notifies that set operation for FEATURE_HVAC_DEFROSTER succeeded or failed.

default void

Notifies that set operation for FEATURE_HVAC_ELECTRIC_DEFROSTER succeeded or failed.

default void

Notifies that set operation for FEATURE_FAN_DIRECTION succeeded or failed.

default void

Notifies that set operation for FEATURE_FAN_SPEED succeeded or failed.

default void

Notifies that set operation for FEATURE_HVAC_AC succeeded or failed.

default void

Notifies that set operation for FEATURE_HVAC_AUTO_MODE succeeded or failed.

default void

Notifies that set operation for FEATURE_HVAC_AUTO_RECIRCULATION succeeded or failed.

default void

Notifies that set operation for FEATURE_HVAC_DUAL_MODE succeeded or failed.

default void

Notifies that set operation for FEATURE_HVAC_MAX_AC succeeded or failed.

default void

Notifies that set operation for FEATURE_HVAC_POWER succeeded or failed.

default void

Notifies that set operation for FEATURE_HVAC_RECIRCULATION succeeded or failed.

default void

Notifies that set operation for FEATURE_HVAC_MAX_DEFROSTER succeeded or failed.

default void

Notifies that set operation for FEATURE_SEAT_TEMPERATURE_LEVEL succeeded or failed.

default void

Notifies that set operation for FEATURE_SEAT_VENTILATION_LEVEL succeeded or failed.

default void

Notifies that set operation for FEATURE_STEERING_WHEEL_HEAT succeeded or failed.

default static @NonNull String
toString(int statusCode)

Returns a human readable string value for the status code.

Constants

OPERATION_STATUS_FEATURE_SETTING_NOT_ALLOWED

Added in 1.3.0
default static final int OPERATION_STATUS_FEATURE_SETTING_NOT_ALLOWED = 4

The feature is read-only feature in the vehicle.

OPERATION_STATUS_FEATURE_TEMPORARILY_UNAVAILABLE

Added in 1.3.0
default static final int OPERATION_STATUS_FEATURE_TEMPORARILY_UNAVAILABLE = 3

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
default static final int OPERATION_STATUS_FEATURE_UNIMPLEMENTED = 1

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
default static final int OPERATION_STATUS_FEATURE_UNSUPPORTED = 2

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
default static final int OPERATION_STATUS_ILLEGAL_CAR_HARDWARE_STATE = 7

The car returned an invalid value that cannot be interpreted.

OPERATION_STATUS_INSUFFICIENT_PERMISSION

Added in 1.3.0
default static final 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.

OPERATION_STATUS_SUCCESS

Added in 1.3.0
default static final int OPERATION_STATUS_SUCCESS = 0

Set operation succeeded.

OPERATION_STATUS_UNSUPPORTED_VALUE

Added in 1.3.0
default static final int OPERATION_STATUS_UNSUPPORTED_VALUE = 5

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
default static final int OPERATION_STATUS_UPDATE_TIMEOUT = 8

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

Public methods

onSetCarClimateStateCabinTemperature

Added in 1.3.0
default void onSetCarClimateStateCabinTemperature(int statusCode)

Notifies that set operation for FEATURE_CABIN_TEMPERATURE succeeded or failed.

Parameters
int statusCode

one of status codes in StatusCode

onSetCarClimateStateDefroster

Added in 1.3.0
default void onSetCarClimateStateDefroster(int statusCode)

Notifies that set operation for FEATURE_HVAC_DEFROSTER succeeded or failed.

Parameters
int statusCode

one of status codes in StatusCode

onSetCarClimateStateElectricDefroster

Added in 1.3.0
default void onSetCarClimateStateElectricDefroster(int statusCode)

Notifies that set operation for FEATURE_HVAC_ELECTRIC_DEFROSTER succeeded or failed.

Parameters
int statusCode

one of status codes in StatusCode

onSetCarClimateStateFanDirection

Added in 1.3.0
default void onSetCarClimateStateFanDirection(int statusCode)

Notifies that set operation for FEATURE_FAN_DIRECTION succeeded or failed.

Parameters
int statusCode

one of status codes in StatusCode

onSetCarClimateStateFanSpeedLevel

Added in 1.3.0
default void onSetCarClimateStateFanSpeedLevel(int statusCode)

Notifies that set operation for FEATURE_FAN_SPEED succeeded or failed.

Parameters
int statusCode

one of status codes in StatusCode

onSetCarClimateStateHvacAc

Added in 1.3.0
default void onSetCarClimateStateHvacAc(int statusCode)

Notifies that set operation for FEATURE_HVAC_AC succeeded or failed.

Parameters
int statusCode

one of status codes in StatusCode

onSetCarClimateStateHvacAutoMode

Added in 1.3.0
default void onSetCarClimateStateHvacAutoMode(int statusCode)

Notifies that set operation for FEATURE_HVAC_AUTO_MODE succeeded or failed.

Parameters
int statusCode

one of status codes in StatusCode

onSetCarClimateStateHvacAutoRecirculation

Added in 1.3.0
default void onSetCarClimateStateHvacAutoRecirculation(int statusCode)

Notifies that set operation for FEATURE_HVAC_AUTO_RECIRCULATION succeeded or failed.

Parameters
int statusCode

one of status codes in StatusCode

onSetCarClimateStateHvacDualMode

Added in 1.3.0
default void onSetCarClimateStateHvacDualMode(int statusCode)

Notifies that set operation for FEATURE_HVAC_DUAL_MODE succeeded or failed.

Parameters
int statusCode

one of status codes in StatusCode

onSetCarClimateStateHvacMaxAcMode

Added in 1.3.0
default void onSetCarClimateStateHvacMaxAcMode(int statusCode)

Notifies that set operation for FEATURE_HVAC_MAX_AC succeeded or failed.

Parameters
int statusCode

one of status codes in StatusCode

onSetCarClimateStateHvacPower

Added in 1.3.0
default void onSetCarClimateStateHvacPower(int statusCode)

Notifies that set operation for FEATURE_HVAC_POWER succeeded or failed.

Parameters
int statusCode

one of status codes in StatusCode

onSetCarClimateStateHvacRecirculation

Added in 1.3.0
default void onSetCarClimateStateHvacRecirculation(int statusCode)

Notifies that set operation for FEATURE_HVAC_RECIRCULATION succeeded or failed.

Parameters
int statusCode

one of status codes in StatusCode

onSetCarClimateStateMaxDefroster

Added in 1.3.0
default void onSetCarClimateStateMaxDefroster(int statusCode)

Notifies that set operation for FEATURE_HVAC_MAX_DEFROSTER succeeded or failed.

Parameters
int statusCode

one of status codes in StatusCode

onSetCarClimateStateSeatTemperatureLevel

Added in 1.3.0
default void onSetCarClimateStateSeatTemperatureLevel(int statusCode)

Notifies that set operation for FEATURE_SEAT_TEMPERATURE_LEVEL succeeded or failed.

Parameters
int statusCode

one of status codes in StatusCode

onSetCarClimateStateSeatVentilationLevel

Added in 1.3.0
default void onSetCarClimateStateSeatVentilationLevel(int statusCode)

Notifies that set operation for FEATURE_SEAT_VENTILATION_LEVEL succeeded or failed.

Parameters
int statusCode

one of status codes in StatusCode

onSetCarClimateStateSteeringWheelHeat

Added in 1.3.0
default void onSetCarClimateStateSteeringWheelHeat(int statusCode)

Notifies that set operation for FEATURE_STEERING_WHEEL_HEAT succeeded or failed.

Parameters
int statusCode

one of status codes in StatusCode

toString

Added in 1.3.0
default static @NonNull String toString(int statusCode)

Returns a human readable string value for the status code.

Parameters
int statusCode

one of status codes in StatusCode

Throws
java.lang.IllegalArgumentException

if status code is not in StatusCode