ServiceAreaTrait.SelectAreasCommand.Response
class ServiceAreaTrait.SelectAreasCommand.Response : ClusterStruct
The result of the completed SelectAreas command.
Summary
Nested types |
|---|
@HomeExperimentalGenericApiDescriptor enum for this command's response fields. |
Public constructors |
|---|
Response(status: ServiceAreaTrait.SelectAreasStatus, statusText: String)Creates a response payload from the SelectAreas 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 |
|
|---|---|
ServiceAreaTrait.SelectAreasStatus |
The status of the |
String |
Text describing the status of the |
Public constructors
Response
Response(
status: ServiceAreaTrait.SelectAreasStatus = SelectAreasStatus.Success,
statusText: String = ""
)
Creates a response payload from the SelectAreas 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
status
val status: ServiceAreaTrait.SelectAreasStatus
The status of the SelectAreas command. If the Status field is set to Success or UnsupportedArea, the server can use a non-empty string for the StatusText field to provide additional information. For example, if Status is set to UnsupportedArea, the server can use StatusText to indicate which areas are unsupported. If the Status field is not set to Success or UnsupportedArea, the StatusText field can include a vendor-defined error description which can be used to explain the error to the user.