# DoorLockTrait.DlStatus

# DoorLockTrait.DlStatus


```
enum DoorLockTrait.DlStatus : 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.DoorLockTrait.DlStatus](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlStatus) |

*** ** * ** ***

Door lock statuses.

## Summary

| ### Enum Values |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlStatus#Duplicate` | The provided credential is a duplicate of an existing entry. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlStatus#Failure` | The operation failed. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlStatus#InvalidField` | The operation failed due to its referring to an invalid field. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlStatus#NotFound` | The operation failed because the specified resource was not found. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlStatus#Occupied` | The provided User ID, Credential ID, or entry location is already occupied. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlStatus#ResourceExhausted` | The operation failed because a resource has been exhausted. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlStatus#Success` | The operation was successful. |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlStatus#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/DoorLockTrait.DlStatus#toDescription()()` |
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlStatus` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlStatus#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/DoorLockTrait.DlStatus>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlStatus#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/DoorLockTrait.DlStatus>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlStatus#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/DoorLockTrait.DlStatus#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/DoorLockTrait.DlStatus#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/DoorLockTrait.DlStatus#value()` Integer identifier of the enum value per the Matter Application Clusters spec, e.g. 1 for Door Lock Cluster AlarmCodeEnum.LockFactoryReset. |

## Enum Values

### Duplicate

```
val DoorLockTrait.DlStatus.Duplicate: DoorLockTrait.DlStatus
```

The provided credential is a duplicate of an existing entry.

### Failure

```
val DoorLockTrait.DlStatus.Failure: DoorLockTrait.DlStatus
```

The operation failed.

### InvalidField

```
val DoorLockTrait.DlStatus.InvalidField: DoorLockTrait.DlStatus
```

The operation failed due to its referring to an invalid field.

### NotFound

```
val DoorLockTrait.DlStatus.NotFound: DoorLockTrait.DlStatus
```

The operation failed because the specified resource was not found.

### Occupied

```
val DoorLockTrait.DlStatus.Occupied: DoorLockTrait.DlStatus
```

The provided User ID, Credential ID, or entry location is already occupied. The entry might need to be deleted or a different ID or location chosen.

### ResourceExhausted

```
val DoorLockTrait.DlStatus.ResourceExhausted: DoorLockTrait.DlStatus
```

The operation failed because a resource has been exhausted.

### Success

```
val DoorLockTrait.DlStatus.Success: DoorLockTrait.DlStatus
```

The operation was successful.

### UnknownValue

```
val DoorLockTrait.DlStatus.UnknownValue: DoorLockTrait.DlStatus
```

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): DoorLockTrait.DlStatus
```

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<DoorLockTrait.DlStatus>
```

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<DoorLockTrait.DlStatus>
```

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.