# ServiceArea

# ServiceArea


```
@Generated(value = ["GoogleHomePlatformCodegen"])
interface ServiceArea : ServiceAreaTrait.Attributes, MatterTrait, ServiceAreaCommands
```

<br />

*** ** * ** ***

API for the ServiceArea trait. This trait provides an interface for controlling the areas where a device should operate, for reporting the status at each area, and for querying the current area.

## Summary

| ### Nested types |
|---|
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceArea.Attribute : 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 trait's attributes. |
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceArea.Command : https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html` Descriptor enum for this trait's commands. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceArea#supports(com.google.home.matter.standard.ServiceArea.Attribute)(attribute: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceArea.Attribute)` |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceArea#supports(com.google.home.matter.standard.ServiceArea.Command)(command: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceArea.Command)` |

| ### Public properties |
|---|---|
| `open https://developers.home.google.com/reference/kotlin/com/google/home/TraitFactory<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceArea>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceArea#factory()` |

| ### Inherited functions |
|---|
| From [com.google.home.matter.standard.ServiceAreaCommands](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaCommands) |---|---| | `suspend https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.SelectAreasCommand.Response` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaCommands#selectAreas(kotlin.collections.List)(newAreas: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>)` Selects the areas where the device should attempt to operate. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.SelectAreasCommand.Response>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaCommands#selectAreasBatchable(kotlin.collections.List)(newAreas: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaCommands#selectAreas(kotlin.collections.List)` command. | | `suspend https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.SkipAreaCommand.Response` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaCommands#skipArea(kotlin.UInt)(skippedArea: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html)` Indicates to the device that the area specified by the `areaID` field should be skipped. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.SkipAreaCommand.Response>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaCommands#skipAreaBatchable(kotlin.UInt)(skippedArea: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaCommands#skipArea(kotlin.UInt)` command. | |
| From [com.google.home.matter.standard.ServiceAreaTrait.Attributes](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.Attributes) |---|---| | `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.Attributes#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.Attributes#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. | |
| From [com.google.home.TraitStateInvalidation](https://developers.home.google.com/reference/kotlin/com/google/home/TraitStateInvalidation) |---|---| | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/TraitStateInvalidation#forceRead()()` | |

| ### Inherited properties |
|---|
| From [com.google.home.matter.standard.ServiceAreaTrait.Attributes](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.Attributes) |---|---| | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.Attributes#acceptedCommandList()` A list of client-generated commands which are supported by this cluster server instance. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.Attributes#attributeList()` A list of the attribute IDs of the attributes supported by the cluster instance. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.Attributes#clusterRevision()` The revision of the server cluster specification supported by the cluster instance. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.Attributes#currentArea()` The area where the device is currently located, regardless of whether it is operating. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.Attributes#estimatedEndTime()` The estimated Unix epoch time for completing service in the area, indicated by the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.Attributes#currentArea()` attribute. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.Feature` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.Attributes#featureMap()` Whether the server supports zero or more optional cluster features. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.Attributes#generatedCommandList()` A list of server-generated commands (server to client) which are supported by this cluster server instance. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.ProgressStruct>?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.Attributes#progress()` The operating status of one or more areas. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html>?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.Attributes#selectedAreas()` The set of areas where the device should attempt to operate. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.AreaStruct>?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.Attributes#supportedAreas()` The list of supported service areas for the device. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.MapStruct>?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ServiceAreaTrait.Attributes#supportedMaps()` The list of supported maps for the device. | |
| From [com.google.home.Trait](https://developers.home.google.com/reference/kotlin/com/google/home/Trait) |---|---| | `https://developers.home.google.com/reference/kotlin/com/google/home/Trait.TraitMetadata` | `https://developers.home.google.com/reference/kotlin/com/google/home/Trait#metadata()` | |

## Public functions

### supports

```
fun supports(attribute: ServiceArea.Attribute): Boolean
```

### supports

```
fun supports(command: ServiceArea.Command): Boolean
```

## Public properties

### factory

```
open val factory: TraitFactory<ServiceArea>
```