OperationalStateCommands

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

Known direct subclasses
OperationalState

API for the OperationalState trait.


Summary

Public functions

suspend OperationalStateTrait.PauseCommand.Response

Pause the device if possible, based on the current operation underway.

BatchableCommand<OperationalStateTrait.PauseCommand.Response>

The batchable version of pause command.

suspend OperationalStateTrait.ResumeCommand.Response

Resume operation if the device is in a state where it can be resumed.

BatchableCommand<OperationalStateTrait.ResumeCommand.Response>

The batchable version of resume command.

suspend OperationalStateTrait.StartCommand.Response

Start the device if the device is in a state where it can be started.

BatchableCommand<OperationalStateTrait.StartCommand.Response>

The batchable version of start command.

suspend OperationalStateTrait.StopCommand.Response

Stop the device if possible, based on the current operation underway.

BatchableCommand<OperationalStateTrait.StopCommand.Response>

The batchable version of stop command.

Public functions

pause

suspend fun pause(): OperationalStateTrait.PauseCommand.Response

Pause the device if possible, based on the current operation underway.

Returns
OperationalStateTrait.PauseCommand.Response

The result of the completed Pause command.

pauseBatchable

fun pauseBatchable(): BatchableCommand<OperationalStateTrait.PauseCommand.Response>

The batchable version of pause command.

Pause the device if possible, based on the current operation underway.

resume

suspend fun resume(): OperationalStateTrait.ResumeCommand.Response

Resume operation if the device is in a state where it can be resumed.

Returns
OperationalStateTrait.ResumeCommand.Response

The result of the completed Resume command.

resumeBatchable

fun resumeBatchable(): BatchableCommand<OperationalStateTrait.ResumeCommand.Response>

The batchable version of resume command.

Resume operation if the device is in a state where it can be resumed.

start

suspend fun start(): OperationalStateTrait.StartCommand.Response

Start the device if the device is in a state where it can be started.

Returns
OperationalStateTrait.StartCommand.Response

The result of the completed Start command.

startBatchable

fun startBatchable(): BatchableCommand<OperationalStateTrait.StartCommand.Response>

The batchable version of start command.

Start the device if the device is in a state where it can be started.

stop

suspend fun stop(): OperationalStateTrait.StopCommand.Response

Stop the device if possible, based on the current operation underway.

Returns
OperationalStateTrait.StopCommand.Response

The result of the completed Stop command.

stopBatchable

fun stopBatchable(): BatchableCommand<OperationalStateTrait.StopCommand.Response>

The batchable version of stop command.

Stop the device if possible, based on the current operation underway.