# ServiceAreaTrait.AreaInfoStruct

# ServiceAreaTrait.AreaInfoStruct


```
class ServiceAreaTrait.AreaInfoStruct : ClusterStruct
```

<br />

*** ** * ** ***

The name and semantic data describing an area.

## Summary

| ### Nested types |
|---|
| `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.AreaInfoStruct.StructFields : https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html, https://developers.home.google.com/reference/kotlin/com/google/home/Field` Descriptor enum for this struct's fields. |

| ### Public constructors |
|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.AreaInfoStruct#AreaInfoStruct(com.google.home.matter.standard.ServiceAreaTrait.LocationDescriptorStruct,com.google.home.matter.standard.ServiceAreaTrait.LandmarkInfoStruct)( locationInfo: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.LocationDescriptorStruct?, landmarkInfo: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.LandmarkInfoStruct? )` Creates the AreaInfoStruct class. |

| ### Public functions |
|---|---|
| `open https://developers.home.google.com/reference/kotlin/com/google/home/StructDescriptor` | `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.AreaInfoStruct#getDescriptor()()` Returns the descriptor for the struct. |
| `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html?` | `@https://developers.home.google.com/reference/kotlin/com/google/home/annotation/HomeExperimentalGenericApi https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.AreaInfoStruct#getFieldValueById(kotlin.UInt)(tagId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html)` Returns the value of the field for the given tag ID. |

| ### Public properties |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.LandmarkInfoStruct?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.AreaInfoStruct#landmarkInfo()` Indicates an association with a landmark. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.LocationDescriptorStruct?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.AreaInfoStruct#locationInfo()` 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.