ZoneManagementCommands

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

Known direct subclasses
ZoneManagement

API for the ZoneManagement trait.

Commands for the ZoneManagement trait.

Summary

Public functions
suspend Unit
BatchableCommand<Unit>
suspend ZoneManagementTrait.CreateTwoDCartesianZoneCommand.Response

Creates and stores a two-dimensional Cartesian zone.
BatchableCommand<ZoneManagementTrait.CreateTwoDCartesianZoneCommand.Response>

The batchable version of createTwoDCartesianZone command.
suspend Unit
BatchableCommand<Unit>
suspend Unit
removeZone(zoneId: UShort)

Removes the user-defined zone indicated by the ZoneID.
BatchableCommand<Unit>

The batchable version of removeZone command.
suspend Unit

Updates a stored two-dimensional Cartesian zone.
BatchableCommand<Unit>

The batchable version of updateTwoDCartesianZone command.

Public functions

createOrUpdateTrigger

suspend fun createOrUpdateTrigger(
    trigger: ZoneManagementTrait.ZoneTriggerControlStruct
): Unit

createOrUpdateTriggerBatchable

fun createOrUpdateTriggerBatchable(
    trigger: ZoneManagementTrait.ZoneTriggerControlStruct
): BatchableCommand<Unit>

createTwoDCartesianZone

suspend fun createTwoDCartesianZone(
    zone: ZoneManagementTrait.TwoDCartesianZoneStruct
): ZoneManagementTrait.CreateTwoDCartesianZoneCommand.Response

Creates and stores a two-dimensional Cartesian zone.

Parameters
zone: ZoneManagementTrait.TwoDCartesianZoneStruct

A TwoDCartesianZoneStruct value representing all information required to define the two-dimensional Cartesian zone.
Returns
ZoneManagementTrait.CreateTwoDCartesianZoneCommand.Response

The result of the CreateTwoDCartesianZone command.

createTwoDCartesianZoneBatchable

fun createTwoDCartesianZoneBatchable(
    zone: ZoneManagementTrait.TwoDCartesianZoneStruct
): BatchableCommand<ZoneManagementTrait.CreateTwoDCartesianZoneCommand.Response>

The batchable version of createTwoDCartesianZone command.

Creates and stores a two-dimensional Cartesian zone.

Parameters
zone: ZoneManagementTrait.TwoDCartesianZoneStruct

A TwoDCartesianZoneStruct value representing all information required to define the two-dimensional Cartesian zone.
Returns
BatchableCommand<ZoneManagementTrait.CreateTwoDCartesianZoneCommand.Response>

BatchableCommand

removeTrigger

suspend fun removeTrigger(zoneId: UShort): Unit

removeTriggerBatchable

fun removeTriggerBatchable(zoneId: UShort): BatchableCommand<Unit>

removeZone

suspend fun removeZone(zoneId: UShort): Unit

Removes the user-defined zone indicated by the ZoneID. The default zone with zoneID = 0 cannot be removed.

removeZoneBatchable

fun removeZoneBatchable(zoneId: UShort): BatchableCommand<Unit>

The batchable version of removeZone command.

Removes the user-defined zone indicated by the ZoneID. The default zone with zoneID = 0 cannot be removed.

Returns
BatchableCommand<Unit>

BatchableCommand

updateTwoDCartesianZone

suspend fun updateTwoDCartesianZone(
    zoneId: UShort,
    zone: ZoneManagementTrait.TwoDCartesianZoneStruct
): Unit

Updates a stored two-dimensional Cartesian zone. When updating the default zone (zoneID = 0), only the use field within the provided TwoDCartesianZoneStruct can be modified.

Parameters
zone: ZoneManagementTrait.TwoDCartesianZoneStruct

A TwoDCartesianZoneStruct value representing updated zone information.

updateTwoDCartesianZoneBatchable

fun updateTwoDCartesianZoneBatchable(
    zoneId: UShort,
    zone: ZoneManagementTrait.TwoDCartesianZoneStruct
): BatchableCommand<Unit>

The batchable version of updateTwoDCartesianZone command.

Updates a stored two-dimensional Cartesian zone. When updating the default zone (zoneID = 0), only the use field within the provided TwoDCartesianZoneStruct can be modified.

Parameters
zone: ZoneManagementTrait.TwoDCartesianZoneStruct

A TwoDCartesianZoneStruct value representing updated zone information.
Returns
BatchableCommand<Unit>

BatchableCommand