ExtendedOperationalStateCommands

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

Known direct subclasses
ExtendedOperationalState

API for the ExtendedOperationalState trait.


Summary

Public functions

suspend Unit
startWithDuration(operationZones: List<String>, durationSeconds: UInt)

Start the device in one or more operation zones for the specified duration.

BatchableCommand<Unit>
startWithDurationBatchable(
    operationZones: List<String>,
    durationSeconds: UInt
)

The batchable version of startWithDuration command.

suspend Unit

Start the device in one or more operation zones.

BatchableCommand<Unit>

The batchable version of startWithOperationZones command.

Public functions

startWithDuration

suspend fun startWithDuration(operationZones: List<String>, durationSeconds: UInt): Unit

Start the device in one or more operation zones for the specified duration.

Parameters
operationZones: List<String>

Indicates one or more zones in which to start running.

durationSeconds: UInt

Indicates how long the action should run, in seconds. Must be between minimum and maximum operation duration supported by the device.

startWithDurationBatchable

fun startWithDurationBatchable(
    operationZones: List<String>,
    durationSeconds: UInt
): BatchableCommand<Unit>

The batchable version of startWithDuration command.

Start the device in one or more operation zones for the specified duration.

Parameters
operationZones: List<String>

Indicates one or more zones in which to start running.

durationSeconds: UInt

Indicates how long the action should run, in seconds. Must be between minimum and maximum operation duration supported by the device.

Returns
BatchableCommand<Unit>

BatchableCommand

startWithOperationZones

suspend fun startWithOperationZones(operationZones: List<String>): Unit

Start the device in one or more operation zones.

Parameters
operationZones: List<String>

Indicates one or more zones in which to start running.

startWithOperationZonesBatchable

fun startWithOperationZonesBatchable(operationZones: List<String>): BatchableCommand<Unit>

The batchable version of startWithOperationZones command.

Start the device in one or more operation zones.

Parameters
operationZones: List<String>

Indicates one or more zones in which to start running.

Returns
BatchableCommand<Unit>

BatchableCommand