# ClosureDimensionTrait.OverflowEnum

# ClosureDimensionTrait.OverflowEnum


```
enum ClosureDimensionTrait.OverflowEnum : Enum, ClusterEnum
```

<br />

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-any/index.html) |||
| ↳ | [kotlin.Enum](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html) ||
|   | ↳ | [com.google.home.matter.standard.ClosureDimensionTrait.OverflowEnum](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum) |

*** ** * ** ***

Describes the overflow state of a composed closure.

## Summary

| ### Enum Values |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum#BottomInside` | Bottom inside overflow. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum#BottomOutside` | Bottom outside overflow. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum#Inside` | Inside overflow. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum#LeftInside` | Left inside overflow. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum#LeftOutside` | Left outside overflow. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum#NoOverflow` | No overflow. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum#Outside` | Outside overflow. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum#RightInside` | Right inside overflow. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum#RightOutside` | Right outside overflow. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum#TopInside` | Top inside overflow. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum#TopOutside` | Top outside overflow. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum#UnknownValue` | The enum value is out of range. |

| ### Public functions |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/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/ClosureDimensionTrait.OverflowEnum#toDescription()()` |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum#valueOf(kotlin.String)(value: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)` Returns the enum constant of this type with the specified name. |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-array/index.html<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum#values()()` Returns an array containing the constants of this enum type, in the order they're declared. |

| ### Public properties |
|---|---|
| `https://developers.home.google.com/reference/kotlin/kotlin/enums/EnumEntries<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum#entries()` Returns a representation of an immutable list of all enum entries, in the order they're declared. |
| `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum#traitId()` Trait identifier of the Matter Cluster that defines the enum Data Type. |
| `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum#typeName()` Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster. |
| `open https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-long/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/ClosureDimensionTrait.OverflowEnum#value()` Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset. |

## Enum Values

### BottomInside

```
val ClosureDimensionTrait.OverflowEnum.BottomInside: ClosureDimensionTrait.OverflowEnum
```

Bottom inside overflow. The panel pivots along its bottom edge, opening inward toward the interior of the room.

### BottomOutside

```
val ClosureDimensionTrait.OverflowEnum.BottomOutside: ClosureDimensionTrait.OverflowEnum
```

Bottom outside overflow. The panel pivots along its bottom edge, opening outward away from the interior of the room.

### Inside

```
val ClosureDimensionTrait.OverflowEnum.Inside: ClosureDimensionTrait.OverflowEnum
```

Inside overflow. The panel opens inward, pivoting from the outside toward the interior side.

### LeftInside

```
val ClosureDimensionTrait.OverflowEnum.LeftInside: ClosureDimensionTrait.OverflowEnum
```

Left inside overflow. The left-hung panel opens inward, pivoting from the right toward the interior of the room.

### LeftOutside

```
val ClosureDimensionTrait.OverflowEnum.LeftOutside: ClosureDimensionTrait.OverflowEnum
```

Left outside overflow. The panel opens outward, pivoting from the right exterior of the building.

### NoOverflow

```
val ClosureDimensionTrait.OverflowEnum.NoOverflow: ClosureDimensionTrait.OverflowEnum
```

No overflow.

### Outside

```
val ClosureDimensionTrait.OverflowEnum.Outside: ClosureDimensionTrait.OverflowEnum
```

Outside overflow. The panel opens outward, pivoting from the inside away from the interior side.

### RightInside

```
val ClosureDimensionTrait.OverflowEnum.RightInside: ClosureDimensionTrait.OverflowEnum
```

Right inside overflow. The right-hung panel opens inward, pivoting from the left toward the interior of the room.

### RightOutside

```
val ClosureDimensionTrait.OverflowEnum.RightOutside: ClosureDimensionTrait.OverflowEnum
```

Right outside overflow. The panel opens outward, pivoting from the left toward the exterior of the building.

### TopInside

```
val ClosureDimensionTrait.OverflowEnum.TopInside: ClosureDimensionTrait.OverflowEnum
```

Top inside overflow. The panel pivots along its top edge, opening inward toward the interior of the room.

### TopOutside

```
val ClosureDimensionTrait.OverflowEnum.TopOutside: ClosureDimensionTrait.OverflowEnum
```

Top outside overflow. The panel pivots along its top edge, opening outward away from the interior of the room.

### UnknownValue

```
val ClosureDimensionTrait.OverflowEnum.UnknownValue: ClosureDimensionTrait.OverflowEnum
```

The enum value is out of range. For example, a newer Matter cluster definition may support enum values not yet supported by the Home APIs.

## Public functions

### toDescription

```
@HomeExperimentalGenericApi
fun toDescription(): String
```

### valueOf

```
fun valueOf(value: String): ClosureDimensionTrait.OverflowEnum
```

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

| Throws |
|---|---|
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-illegal-argument-exception/index.html` | if this enum type has no constant with the specified name |

### values

```
fun values(): Array<ClosureDimensionTrait.OverflowEnum>
```

Returns an array containing the constants of this enum type, in the order they're declared.

This method may be used to iterate over the constants.

## Public properties

### entries

```
val entries: EnumEntries<ClosureDimensionTrait.OverflowEnum>
```

Returns a representation of an immutable list of all enum entries, in the order they're declared.

This method may be used to iterate over the enum entries.

### traitId

```
open val traitId: String
```

Trait identifier of the Matter Cluster that defines the enum Data Type. Refer to `https://developers.home.google.com/reference/kotlin/com/google/home/matter/serialization/ClusterId#traitId()` for the format.

### typeName

```
open val typeName: String
```

Name of the Matter Data Type that the enum belongs to, in UpperCamelCase, e.g. "AlarmCodeEnum" from Door Lock Cluster.

### value

```
open val value: ULong
```

Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset.