ServiceAreaTrait.AreaInfoStruct
class ServiceAreaTrait.AreaInfoStruct : ClusterStruct
The name and semantic data describing an area.
Summary
Nested types |
|---|
|
Descriptor enum for this struct's fields. |
Public constructors |
|---|
AreaInfoStruct(Creates the AreaInfoStruct class. |
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.LandmarkInfoStruct? |
Indicates an association with a landmark. |
ServiceAreaTrait.LocationDescriptorStruct? |
The name of the area, floor number or area type. |
Public constructors
AreaInfoStruct
AreaInfoStruct(
locationInfo: ServiceAreaTrait.LocationDescriptorStruct? = null,
landmarkInfo: ServiceAreaTrait.LandmarkInfoStruct? = null
)
Creates the AreaInfoStruct class.
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
landmarkInfo
val landmarkInfo: ServiceAreaTrait.LandmarkInfoStruct?
Indicates an association with a landmark. For example, this may indicate that the area refers to a zone next to a table. A value of null indicates that the information is not available or known.
locationInfo
val locationInfo: ServiceAreaTrait.LocationDescriptorStruct?
The name of the area, floor number or area type. Area-type values come from the Matter Common Area Type Namespace.