DishwasherAlarmCommands

@Generated(value = ["GoogleHomePlatformCodegen"])
interface DishwasherAlarmCommands

Known direct subclasses
DishwasherAlarm

API for the DishwasherAlarm trait.


Summary

Public functions

suspend Unit

The details of a request to modify an enabled alarm.

BatchableCommand<Unit>

The batchable version of modifyEnabledAlarms command.

suspend Unit

The details of a request to reset active and, if possible, latched alarms.

BatchableCommand<Unit>

The batchable version of reset command.

Public functions

modifyEnabledAlarms

suspend fun modifyEnabledAlarms(mask: DishwasherAlarmTrait.AlarmBitmap): Unit

The details of a request to modify an enabled alarm.

Parameters
mask: DishwasherAlarmTrait.AlarmBitmap

A bitmap indicating an alarm that should be enabled or suppressed. Valid values are defined in AlarmBitmap.

modifyEnabledAlarmsBatchable

fun modifyEnabledAlarmsBatchable(mask: DishwasherAlarmTrait.AlarmBitmap): BatchableCommand<Unit>

The batchable version of modifyEnabledAlarms command.

The details of a request to modify an enabled alarm.

Parameters
mask: DishwasherAlarmTrait.AlarmBitmap

A bitmap indicating an alarm that should be enabled or suppressed. Valid values are defined in AlarmBitmap.

Returns
BatchableCommand<Unit>

BatchableCommand

reset

suspend fun reset(alarms: DishwasherAlarmTrait.AlarmBitmap): Unit

The details of a request to reset active and, if possible, latched alarms.

Parameters
alarms: DishwasherAlarmTrait.AlarmBitmap

A bitmap indicating an alarm that will be reset unless manual intervention is required. Valid values are defined in AlarmBitmap.

resetBatchable

fun resetBatchable(alarms: DishwasherAlarmTrait.AlarmBitmap): BatchableCommand<Unit>

The batchable version of reset command.

The details of a request to reset active and, if possible, latched alarms.

Parameters
alarms: DishwasherAlarmTrait.AlarmBitmap

A bitmap indicating an alarm that will be reset unless manual intervention is required. Valid values are defined in AlarmBitmap.

Returns
BatchableCommand<Unit>

BatchableCommand