ServiceAreaCommands

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

Known direct subclasses
ServiceArea

API for the ServiceArea trait.

Commands for the ServiceArea trait.

Summary

Public functions
suspend ServiceAreaTrait.SelectAreasCommand.Response
selectAreas(newAreas: List<UInt>)

Selects the areas where the device should attempt to operate.
BatchableCommand<ServiceAreaTrait.SelectAreasCommand.Response>

The batchable version of selectAreas command.
suspend ServiceAreaTrait.SkipAreaCommand.Response
skipArea(skippedArea: UInt)

Indicates to the device that the area specified by the areaID field should be skipped.
BatchableCommand<ServiceAreaTrait.SkipAreaCommand.Response>
skipAreaBatchable(skippedArea: UInt)

The batchable version of skipArea command.

Public functions

selectAreas

suspend fun selectAreas(newAreas: List<UInt>): ServiceAreaTrait.SelectAreasCommand.Response

Selects the areas where the device should attempt to operate.

Parameters
newAreas: List<UInt>

The list of areas where the device should attempt to operate.
Returns
ServiceAreaTrait.SelectAreasCommand.Response

The result of the completed SelectAreas command.

selectAreasBatchable

fun selectAreasBatchable(newAreas: List<UInt>): BatchableCommand<ServiceAreaTrait.SelectAreasCommand.Response>

The batchable version of selectAreas command.

Selects the areas where the device should attempt to operate.

Parameters
newAreas: List<UInt>

The list of areas where the device should attempt to operate.
Returns
BatchableCommand<ServiceAreaTrait.SelectAreasCommand.Response>

BatchableCommand

skipArea

suspend fun skipArea(skippedArea: UInt): ServiceAreaTrait.SkipAreaCommand.Response

Indicates to the device that the area specified by the areaID field should be skipped.

Parameters
skippedArea: UInt

The area to skip, and to attempt operating in other areas on the supportedAreas attribute list.
Returns
ServiceAreaTrait.SkipAreaCommand.Response

The result of the completed SkipArea command.

skipAreaBatchable

fun skipAreaBatchable(skippedArea: UInt): BatchableCommand<ServiceAreaTrait.SkipAreaCommand.Response>

The batchable version of skipArea command.

Indicates to the device that the area specified by the areaID field should be skipped.

Parameters
skippedArea: UInt

The area to skip, and to attempt operating in other areas on the supportedAreas attribute list.
Returns
BatchableCommand<ServiceAreaTrait.SkipAreaCommand.Response>

BatchableCommand