# DoorLock

# DoorLock


```
@Generated(value = ["GoogleHomePlatformCodegen"])
interface DoorLock : DoorLockTrait.Attributes, MatterTrait, Updatable, DoorLockCommands
```

<br />

*** ** * ** ***

API for the DoorLock trait. This trait provides an interface to a generic way to secure a door.

## Summary

| ### Nested types |
|---|
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLock.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/DoorLock.Command : https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html` Descriptor enum for this trait's commands. |
| `class https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLock.DoorLockAlarmEvent : https://developers.home.google.com/reference/kotlin/com/google/home/Event, https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DoorLockAlarm` |
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLock.DoorLockAlarmEvent.EventFields : 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 event's fields. |
| `class https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLock.DoorStateChangeEvent : https://developers.home.google.com/reference/kotlin/com/google/home/Event, https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DoorStateChange` |
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLock.DoorStateChangeEvent.EventFields : 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 event's fields. |
| `class https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLock.LockOperationErrorEvent : https://developers.home.google.com/reference/kotlin/com/google/home/Event, https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.LockOperationError` |
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLock.LockOperationErrorEvent.EventFields : 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 event's fields. |
| `class https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLock.LockOperationEvent : https://developers.home.google.com/reference/kotlin/com/google/home/Event, https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.LockOperation` |
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLock.LockOperationEvent.EventFields : 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 event's fields. |
| `class https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLock.LockUserChangeEvent : https://developers.home.google.com/reference/kotlin/com/google/home/Event, https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.LockUserChange` |
| `enum https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLock.LockUserChangeEvent.EventFields : 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 event's fields. |

| ### 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/DoorLock#supports(com.google.home.matter.standard.DoorLock.Attribute)(attribute: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLock.Attribute)` |
| `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLock#supports(com.google.home.matter.standard.DoorLock.Command)(command: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLock.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/DoorLock>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLock#factory()` |

| ### Inherited functions |
|---|
| From [com.google.home.matter.standard.DoorLockCommands](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands) |---|---| | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#clearAliroReaderConfig()()` | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#clearAliroReaderConfigBatchable()()` | | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#clearCredential(com.google.home.matter.standard.DoorLockTrait.CredentialStruct)(credential: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.CredentialStruct?)` Clear a single credential, one type of credential, or all credentials except `ProgrammingPIN` credentials. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#clearCredentialBatchable(com.google.home.matter.standard.DoorLockTrait.CredentialStruct)(credential: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.CredentialStruct?)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#clearCredential(com.google.home.matter.standard.DoorLockTrait.CredentialStruct)` command. | | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#clearHolidaySchedule(kotlin.UByte)(holidayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html)` Clear the specified holiday schedule, or all holiday schedules. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#clearHolidayScheduleBatchable(kotlin.UByte)(holidayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#clearHolidaySchedule(kotlin.UByte)` command. | | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#clearUser(kotlin.UShort)(userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html)` Clear the specified user. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#clearUserBatchable(kotlin.UShort)(userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#clearUser(kotlin.UShort)` command. | | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#clearWeekDaySchedule(kotlin.UByte,kotlin.UShort)(weekDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html)` Clear the specified week day schedule or all week day schedules for the specific user. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#clearWeekDayScheduleBatchable(kotlin.UByte,kotlin.UShort)(weekDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#clearWeekDaySchedule(kotlin.UByte,kotlin.UShort)` command. | | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#clearYearDaySchedule(kotlin.UByte,kotlin.UShort)(yearDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html)` Clear the specified year day schedule, or all year day schedules for the specific user. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#clearYearDayScheduleBatchable(kotlin.UByte,kotlin.UShort)(yearDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#clearYearDaySchedule(kotlin.UByte,kotlin.UShort)` command. | | `suspend https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.GetCredentialStatusCommand.Response` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#getCredentialStatus(com.google.home.matter.standard.DoorLockTrait.CredentialStruct)(credential: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.CredentialStruct)` Retrieve the status of the specified credential. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.GetCredentialStatusCommand.Response>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#getCredentialStatusBatchable(com.google.home.matter.standard.DoorLockTrait.CredentialStruct)( credential: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.CredentialStruct )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#getCredentialStatus(com.google.home.matter.standard.DoorLockTrait.CredentialStruct)` command. | | `suspend https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.GetHolidayScheduleCommand.Response` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#getHolidaySchedule(kotlin.UByte)(holidayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html)` Get the holiday schedule for the specified holiday index. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.GetHolidayScheduleCommand.Response>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#getHolidayScheduleBatchable(kotlin.UByte)(holidayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#getHolidaySchedule(kotlin.UByte)` command. | | `suspend https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.GetUserCommand.Response` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#getUser(kotlin.UShort)(userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html)` Retrieve the user type for a specific user. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.GetUserCommand.Response>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#getUserBatchable(kotlin.UShort)(userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#getUser(kotlin.UShort)` command. | | `suspend https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.GetWeekDayScheduleCommand.Response` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#getWeekDaySchedule(kotlin.UByte,kotlin.UShort)(weekDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html)` Retrieve the weekly schedule for the specified user. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.GetWeekDayScheduleCommand.Response>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#getWeekDayScheduleBatchable(kotlin.UByte,kotlin.UShort)(weekDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#getWeekDaySchedule(kotlin.UByte,kotlin.UShort)` command. | | `suspend https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.GetYearDayScheduleCommand.Response` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#getYearDaySchedule(kotlin.UByte,kotlin.UShort)(yearDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html)` Retrieve the specified year day schedule for the specified user. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.GetYearDayScheduleCommand.Response>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#getYearDayScheduleBatchable(kotlin.UByte,kotlin.UShort)(yearDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#getYearDaySchedule(kotlin.UByte,kotlin.UShort)` command. | | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#lockDoor(kotlin.Function1)(optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.LockDoorCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` Lock the door. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#lockDoorBatchable(kotlin.Function1)(optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.LockDoorCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#lockDoor(kotlin.Function1)` command. | | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#setAliroReaderConfig(kotlin.ByteArray,kotlin.ByteArray,kotlin.ByteArray,kotlin.Function1)( signingKey: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html, verificationKey: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html, groupIdentifier: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.SetAliroReaderConfigCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html )` | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#setAliroReaderConfigBatchable(kotlin.ByteArray,kotlin.ByteArray,kotlin.ByteArray,kotlin.Function1)( signingKey: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html, verificationKey: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html, groupIdentifier: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.SetAliroReaderConfigCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html )` | | `suspend https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.SetCredentialCommand.Response` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#setCredential(com.google.home.matter.standard.DoorLockTrait.DataOperationTypeEnum,com.google.home.matter.standard.DoorLockTrait.CredentialStruct,kotlin.ByteArray,kotlin.UShort,com.google.home.matter.standard.DoorLockTrait.UserStatusEnum,com.google.home.matter.standard.DoorLockTrait.UserTypeEnum)( operationType: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DataOperationTypeEnum, credential: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.CredentialStruct, credentialData: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html, userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?, userStatus: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.UserStatusEnum?, userType: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.UserTypeEnum? )` Set a credential into the lock for a new or existing user, or for a programming user. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.SetCredentialCommand.Response>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#setCredentialBatchable(com.google.home.matter.standard.DoorLockTrait.DataOperationTypeEnum,com.google.home.matter.standard.DoorLockTrait.CredentialStruct,kotlin.ByteArray,kotlin.UShort,com.google.home.matter.standard.DoorLockTrait.UserStatusEnum,com.google.home.matter.standard.DoorLockTrait.UserTypeEnum)( operationType: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DataOperationTypeEnum, credential: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.CredentialStruct, credentialData: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html, userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?, userStatus: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.UserStatusEnum?, userType: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.UserTypeEnum? )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#setCredential(com.google.home.matter.standard.DoorLockTrait.DataOperationTypeEnum,com.google.home.matter.standard.DoorLockTrait.CredentialStruct,kotlin.ByteArray,kotlin.UShort,com.google.home.matter.standard.DoorLockTrait.UserStatusEnum,com.google.home.matter.standard.DoorLockTrait.UserTypeEnum)` command. | | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#setHolidaySchedule(kotlin.UByte,kotlin.UInt,kotlin.UInt,com.google.home.matter.standard.DoorLockTrait.OperatingModeEnum)( holidayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, localStartTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html, localEndTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html, operatingMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.OperatingModeEnum )` Set the holiday schedule by specifying the local start and end time with respect to a specific lock operating mode. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#setHolidayScheduleBatchable(kotlin.UByte,kotlin.UInt,kotlin.UInt,com.google.home.matter.standard.DoorLockTrait.OperatingModeEnum)( holidayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, localStartTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html, localEndTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html, operatingMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.OperatingModeEnum )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#setHolidaySchedule(kotlin.UByte,kotlin.UInt,kotlin.UInt,com.google.home.matter.standard.DoorLockTrait.OperatingModeEnum)` command. | | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#setUser(com.google.home.matter.standard.DoorLockTrait.DataOperationTypeEnum,kotlin.UShort,kotlin.String,kotlin.UInt,com.google.home.matter.standard.DoorLockTrait.UserStatusEnum,com.google.home.matter.standard.DoorLockTrait.UserTypeEnum,com.google.home.matter.standard.DoorLockTrait.CredentialRuleEnum)( operationType: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DataOperationTypeEnum, userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, userName: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html?, userUniqueId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?, userStatus: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.UserStatusEnum?, userType: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.UserTypeEnum?, credentialRule: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.CredentialRuleEnum? )` Set the user on the lock. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#setUserBatchable(com.google.home.matter.standard.DoorLockTrait.DataOperationTypeEnum,kotlin.UShort,kotlin.String,kotlin.UInt,com.google.home.matter.standard.DoorLockTrait.UserStatusEnum,com.google.home.matter.standard.DoorLockTrait.UserTypeEnum,com.google.home.matter.standard.DoorLockTrait.CredentialRuleEnum)( operationType: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DataOperationTypeEnum, userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, userName: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html?, userUniqueId: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?, userStatus: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.UserStatusEnum?, userType: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.UserTypeEnum?, credentialRule: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.CredentialRuleEnum? )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#setUser(com.google.home.matter.standard.DoorLockTrait.DataOperationTypeEnum,kotlin.UShort,kotlin.String,kotlin.UInt,com.google.home.matter.standard.DoorLockTrait.UserStatusEnum,com.google.home.matter.standard.DoorLockTrait.UserTypeEnum,com.google.home.matter.standard.DoorLockTrait.CredentialRuleEnum)` command. | | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#setWeekDaySchedule(kotlin.UByte,kotlin.UShort,com.google.home.matter.standard.DoorLockTrait.DaysMaskMap,kotlin.UByte,kotlin.UByte,kotlin.UByte,kotlin.UByte)( weekDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, daysMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DaysMaskMap, startHour: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, startMinute: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, endHour: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, endMinute: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html )` Set a weekly repeating schedule for the specified user. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#setWeekDayScheduleBatchable(kotlin.UByte,kotlin.UShort,com.google.home.matter.standard.DoorLockTrait.DaysMaskMap,kotlin.UByte,kotlin.UByte,kotlin.UByte,kotlin.UByte)( weekDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, daysMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DaysMaskMap, startHour: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, startMinute: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, endHour: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, endMinute: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html )` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#setWeekDaySchedule(kotlin.UByte,kotlin.UShort,com.google.home.matter.standard.DoorLockTrait.DaysMaskMap,kotlin.UByte,kotlin.UByte,kotlin.UByte,kotlin.UByte)` command. | | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#setYearDaySchedule(kotlin.UByte,kotlin.UShort,kotlin.UInt,kotlin.UInt)( yearDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, localStartTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html, localEndTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html )` Set a time-specific schedule ID for a specified user. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#setYearDayScheduleBatchable(kotlin.UByte,kotlin.UShort,kotlin.UInt,kotlin.UInt)( yearDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html, userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, localStartTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html, localEndTime: 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/DoorLockCommands#setYearDaySchedule(kotlin.UByte,kotlin.UShort,kotlin.UInt,kotlin.UInt)` command. | | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#unboltDoor(kotlin.Function1)(optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.UnboltDoorCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` Disengage the deadbolt. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#unboltDoorBatchable(kotlin.Function1)(optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.UnboltDoorCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#unboltDoor(kotlin.Function1)` command. | | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#unlockDoor(kotlin.Function1)(optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.UnlockDoorCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` Unlock the door. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#unlockDoorBatchable(kotlin.Function1)(optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.UnlockDoorCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#unlockDoor(kotlin.Function1)` command. | | `suspend https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#unlockWithTimeout(kotlin.UShort,kotlin.Function1)(timeout: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.UnlockWithTimeoutCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` Unlock the door with a timeout parameter. | | `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#unlockWithTimeoutBatchable(kotlin.UShort,kotlin.Function1)(timeout: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html, optionalArgs: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.UnlockWithTimeoutCommand.OptionalArgs.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#unlockWithTimeout(kotlin.UShort,kotlin.Function1)` command. | |
| From [com.google.home.matter.standard.DoorLockTrait.Attributes](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.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/DoorLockTrait.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/DoorLockTrait.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()()` | |
| From [com.google.home.Updatable](https://developers.home.google.com/reference/kotlin/com/google/home/Updatable) |---|---| | `suspend https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLock` | `https://developers.home.google.com/reference/kotlin/com/google/home/Updatable#update(kotlin.Function1,kotlin.Function1)(optimisticReturn: (https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLock) -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html, init: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.MutableAttributes.() -> https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html)` Creates a mutable copy of an object and calls the given function to mutate it, then saves it and returns a new immutable copy with the updated state. | |

| ### Inherited properties |
|---|
| From [com.google.home.matter.standard.DoorLockTrait.Attributes](https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.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/DoorLockTrait.Attributes#acceptedCommandList()` A list of client-generated commands which are supported by this cluster server instance. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#actuatorEnabled()` Indicates whether the lock is able to process remote Lock, Unlock, or Unlock with Timeout commands. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#aliroBleAdvertisingVersion()` | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html>?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#aliroExpeditedTransactionSupportedProtocolVersions()` | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#aliroGroupResolvingKey()` | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#aliroReaderGroupIdentifier()` | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#aliroReaderGroupSubIdentifier()` | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#aliroReaderVerificationKey()` | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html>?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#aliroSupportedBleUwbProtocolVersions()` | | `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/DoorLockTrait.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-int/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#autoRelockTime()` The number of seconds to wait after unlocking a lock before it automatically locks again. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#clusterRevision()` The revision of the server cluster specification supported by the cluster instance. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlCredentialRuleMask?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#credentialRulesSupport()` Bitmap which indicates which credential rules are supported by the door lock. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlDefaultConfigurationRegister?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#defaultConfigurationRegister()` The default settings for the door lock device. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#doorClosedEvents()` The number of door closed events that have occurred since it was last zeroed. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#doorOpenEvents()` The number of door opened events that have occurred since it was last zeroed. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DoorStateEnum?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#doorState()` The current door state as defined in `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DoorStateEnum`. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#enableInsideStatusLed()` Enables or disables an inside LED that allows the user to see at a glance if the door is locked. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#enableLocalProgramming()` Enable or disable local programming of certain features, as enumerated in the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#localProgrammingFeatures()` attribute. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#enableOneTouchLocking()` Enables or disables the ability to lock the door lock with a single touch on the door lock. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#enablePrivacyModeButton()` Enable or disable a button inside the door that is used to put the lock into privacy mode. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#expiringUserTimeout()` The number of minutes a PIN, RFID, fingerprint, or other credential associated with a user of type `ExpiringUser` remains valid after its first use before expiring. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Feature` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.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/DoorLockTrait.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/-string/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#language()` The language used for the user interface. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#ledSettings()` The settings for the LED support three different modes. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlLocalProgrammingFeatures?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#localProgrammingFeatures()` The local programming features that are disabled when the `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#enableLocalProgramming()` attribute is set to `false`. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlLockState?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#lockState()` Indicates the current state of the lock. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlLockType?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#lockType()` The type of lock. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#maxPinCodeLength()` The maximum length in bytes of a PIN Code on this device. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#maxRfidCodeLength()` The maximum length in bytes of a RFID Code on this device. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#minPinCodeLength()` The minimum length in bytes of a PIN Code on this device. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#minRfidCodeLength()` The minimum length in bytes of a RFID Code on this device. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#numberOfAliroCredentialIssuerKeysSupported()` | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#numberOfAliroEndpointKeysSupported()` | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#numberOfCredentialsSupportedPerUser()` The number of credentials that could be assigned for each user. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#numberOfHolidaySchedulesSupported()` The number of holiday schedules supported for the door lock device. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#numberOfPinUsersSupported()` The number of PIN users supported. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#numberOfRfidUsersSupported()` The number of RFID users supported. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#numberOfTotalUsersSupported()` Number of total users supported by the lock. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#numberOfWeekDaySchedulesSupportedPerUser()` The number of configurable week day schedules supported per user. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#numberOfYearDaySchedulesSupportedPerUser()` The number of configurable year day schedules supported per user. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#openPeriod()` This attribute holds the number of minutes the door has been open since the last time it transitioned from closed to open. | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.OperatingModeEnum?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#operatingMode()` The current operating mode of the lock. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#requirePinforRemoteOperation()` `true` if the door lock server requires that an optional PINs be included in the payload of remote lock operation events like Lock, Unlock, Unlock with Timeout and Toggle in order to function. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#sendPinOverTheAir()` `true` if it is ok for the door lock to send PINs over the air. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#soundVolume()` Has one of four possible settings: - `0` - Silent Mode - `1` - Low Volume - `2` - High Volume - `3` - Medium Volume <br /> | | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DlSupportedOperatingModes?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#supportedOperatingModes()` Indicates which operating modes are supported by the lock. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#userCodeTemporaryDisableTime()` The number of seconds that the lock shuts down following wrong code entry. | | `https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html?` | `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.Attributes#wrongCodeEntryLimit()` The number of incorrect credential attempts allowed before the lock enters the lockout state. | |
| 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: DoorLock.Attribute): Boolean
```

### supports

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

## Public properties

### factory

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