ThermostatTrait.AtomicRequestCommand.Request
class ThermostatTrait.AtomicRequestCommand.Request : ClusterStruct
The request payload for the AtomicRequest command.
Summary
Nested types |
|---|
@HomeExperimentalGenericApiDescriptor enum for this command's request fields. |
Public constructors |
|---|
Request(Creates a request payload for the AtomicRequest command. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
Returns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
List<UInt> |
A list of attribute IDs the client wishes to write to during an atomic request. |
ThermostatTrait.AtomicRequestTypeEnum |
The type of atomic request being made by the client. |
OptionalValue<UShort> |
An interval in milliseconds in which the client will either commit or rollback the atomic write. |
Public constructors
Request
Request(
requestType: ThermostatTrait.AtomicRequestTypeEnum = AtomicRequestTypeEnum.BeginWrite,
attributeRequests: List<UInt> = emptyList(),
timeout: OptionalValue<UShort> = OptionalValue.absent()
)
Creates a request payload for the AtomicRequest command.
Public functions
getDescriptor
@HomeExperimentalGenericApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalGenericApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
attributeRequests
val attributeRequests: List<UInt>
A list of attribute IDs the client wishes to write to during an atomic request.
requestType
val requestType: ThermostatTrait.AtomicRequestTypeEnum
The type of atomic request being made by the client.
timeout
val timeout: OptionalValue<UShort>
An interval in milliseconds in which the client will either commit or rollback the atomic write.