OperationalStateCommands

interface OperationalStateCommands

Known direct subclasses

OperationalState

API for the OperationalState trait.

Summary

Public functions
`suspend OperationalStateTrait.PauseCommand.Response`	`pause()` Pause the device if possible, based on the current operation underway.
`suspend OperationalStateTrait.ResumeCommand.Response`	`resume()` Resume operation if the device is in a state where it can be resumed.
`suspend OperationalStateTrait.StartCommand.Response`	`start()` Start the device if the device is in a state where it can be started.
`suspend OperationalStateTrait.StopCommand.Response`	`stop()` Stop the device if possible, based on the current operation underway.

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.

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.

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.

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.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2024-10-28 UTC.

For devices
- Matter
  New IP-based smart home connectivity protocol that enables broad interoperability with many ecosystems
- Cloud-to-cloud
  Connect your cloud backend with the Smart Home API
- Find out which integration to build
  We’ll recommend an integration based on your device and needs
For apps, platforms & services
- Home APIs
  Access over 600M devices, hubs for Google Home and Matter infrastructure, and an automation engine powered by Google intelligence
Use cases
Business resources
Console
- Developer Console
- Support
- Stack Overflow
- Google Nest Community