RvcOperationalStateCommands

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

Known direct subclasses
RvcOperationalState

API for the RvcOperationalState trait.


Summary

Public functions

suspend RvcOperationalStateTrait.GoHomeCommand.Response

Send the device to its home base.

BatchableCommand<RvcOperationalStateTrait.GoHomeCommand.Response>

The batchable version of goHome command.

suspend RvcOperationalStateTrait.PauseCommand.Response

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

BatchableCommand<RvcOperationalStateTrait.PauseCommand.Response>

The batchable version of pause command.

suspend RvcOperationalStateTrait.ResumeCommand.Response

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

BatchableCommand<RvcOperationalStateTrait.ResumeCommand.Response>

The batchable version of resume command.

Public functions

goHome

suspend fun goHome(): RvcOperationalStateTrait.GoHomeCommand.Response

Send the device to its home base.

Returns
RvcOperationalStateTrait.GoHomeCommand.Response

The result of the completed GoHome command.

goHomeBatchable

fun goHomeBatchable(): BatchableCommand<RvcOperationalStateTrait.GoHomeCommand.Response>

The batchable version of goHome command.

Send the device to its home base.

pause

suspend fun pause(): RvcOperationalStateTrait.PauseCommand.Response

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

Returns
RvcOperationalStateTrait.PauseCommand.Response

The result of the completed Pause command.

pauseBatchable

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

The batchable version of pause command.

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

resume

suspend fun resume(): RvcOperationalStateTrait.ResumeCommand.Response

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

Returns
RvcOperationalStateTrait.ResumeCommand.Response

The result of the completed Resume command.

resumeBatchable

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

The batchable version of resume command.

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