ServiceAreaTrait.AreaStruct
class ServiceAreaTrait.AreaStruct : ClusterStruct
Data about an area known to the server.
Summary
Nested types |
|---|
|
Descriptor enum for this struct's fields. |
Public constructors |
|---|
AreaStruct(Creates the AreaStruct 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 |
|
|---|---|
UInt |
The identifier of the area. |
ServiceAreaTrait.AreaInfoStruct |
Data describing the area. |
UInt? |
The map identifier which the area is associated with. |
Public constructors
AreaStruct
AreaStruct(
areaId: UInt,
mapId: UInt? = null,
areaInfo: ServiceAreaTrait.AreaInfoStruct = AreaInfoStruct()
)
Creates the AreaStruct 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
areaInfo
val areaInfo: ServiceAreaTrait.AreaInfoStruct
Data describing the area. This field is used by clients to determine the name or the semantics of a certain area.
mapId
val mapId: UInt?
The map identifier which the area is associated with. A value of null indicates that the area is not associated with a map. If the supportedMaps attribute is not empty, this field matches the MapID field of an entry from the supportedMaps attribute's list. If the supportedMaps attribute is empty, this field is null.