# DoorLockCommands

# DoorLockCommands


```
@Generated(value = ["GoogleHomePlatformCodegen"])
interface DoorLockCommands
```

<br />

Known direct subclasses [DoorLock](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` | API for the DoorLock trait. |

*** ** * ** ***

Commands for the DoorLock trait.

## Summary

| ### Public functions |
|---|---|
| `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. |

## Public functions

### clearAliroReaderConfig

```
suspend fun clearAliroReaderConfig(): Unit
```

### clearAliroReaderConfigBatchable

```
fun clearAliroReaderConfigBatchable(): BatchableCommand<Unit>
```

### clearCredential

```
suspend fun clearCredential(credential: DoorLockTrait.CredentialStruct?): Unit
```

Clear a single credential, one type of credential, or all credentials except `ProgrammingPIN` credentials.

| Parameters |
|---|---|
| `credential: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.CredentialStruct?` | The credential to be cleared. |

### clearCredentialBatchable

```
fun clearCredentialBatchable(credential: DoorLockTrait.CredentialStruct?): BatchableCommand<Unit>
```

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.

Clear a single credential, one type of credential, or all credentials except `ProgrammingPIN` credentials.

| Parameters |
|---|---|
| `credential: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.CredentialStruct?` | The credential to be cleared. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### clearHolidaySchedule

```
suspend fun clearHolidaySchedule(holidayIndex: UByte): Unit
```

Clear the specified holiday schedule, or all holiday schedules.

| Parameters |
|---|---|
| `holidayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The unique identifier for the holiday schedule to clear. `0xFE` clears all holiday schedules. |

### clearHolidayScheduleBatchable

```
fun clearHolidayScheduleBatchable(holidayIndex: UByte): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#clearHolidaySchedule(kotlin.UByte)` command.

Clear the specified holiday schedule, or all holiday schedules.

| Parameters |
|---|---|
| `holidayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The unique identifier for the holiday schedule to clear. `0xFE` clears all holiday schedules. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### clearUser

```
suspend fun clearUser(userIndex: UShort): Unit
```

Clear the specified user.

| Parameters |
|---|---|
| `userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The unique identifier for the user to clear. `0xFFFE` clears all users. |

### clearUserBatchable

```
fun clearUserBatchable(userIndex: UShort): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#clearUser(kotlin.UShort)` command.

Clear the specified user.

| Parameters |
|---|---|
| `userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The unique identifier for the user to clear. `0xFFFE` clears all users. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### clearWeekDaySchedule

```
suspend fun clearWeekDaySchedule(weekDayIndex: UByte, userIndex: UShort): Unit
```

Clear the specified week day schedule or all week day schedules for the specific user.

Week day schedules are used to restrict access to a specified time window on certain days of the week. The schedule is repeated each week.

| Parameters |
|---|---|
| `weekDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The unique identifier for the week day schedule to clear. `0xFE` clears all week day schedules for the specified user. |
| `userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The unique identifier for the user whose schedule is to be cleared. |

### clearWeekDayScheduleBatchable

```
fun clearWeekDayScheduleBatchable(weekDayIndex: UByte, userIndex: UShort): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#clearWeekDaySchedule(kotlin.UByte,kotlin.UShort)` command.

Clear the specified week day schedule or all week day schedules for the specific user.

Week day schedules are used to restrict access to a specified time window on certain days of the week. The schedule is repeated each week.

| Parameters |
|---|---|
| `weekDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The unique identifier for the week day schedule to clear. `0xFE` clears all week day schedules for the specified user. |
| `userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The unique identifier for the user whose schedule is to be cleared. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### clearYearDaySchedule

```
suspend fun clearYearDaySchedule(yearDayIndex: UByte, userIndex: UShort): Unit
```

Clear the specified year day schedule, or all year day schedules for the specific user.

Year day schedules are used to restrict access to a specified date and time window.

| Parameters |
|---|---|
| `yearDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The unique identifier for the year day schedule to clear. `0xFE` clears all year day schedules for the specified user. |
| `userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The unique identifier for the user whose year day schedule is to be cleared. |

### clearYearDayScheduleBatchable

```
fun clearYearDayScheduleBatchable(yearDayIndex: UByte, userIndex: UShort): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#clearYearDaySchedule(kotlin.UByte,kotlin.UShort)` command.

Clear the specified year day schedule, or all year day schedules for the specific user.

Year day schedules are used to restrict access to a specified date and time window.

| Parameters |
|---|---|
| `yearDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The unique identifier for the year day schedule to clear. `0xFE` clears all year day schedules for the specified user. |
| `userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The unique identifier for the user whose year day schedule is to be cleared. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### getCredentialStatus

```
suspend fun getCredentialStatus(credential: DoorLockTrait.CredentialStruct): DoorLockTrait.GetCredentialStatusCommand.Response
```

Retrieve the status of the specified credential.

| Parameters |
|---|---|
| `credential: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.CredentialStruct` | The credential whose status is to be retrieved. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.GetCredentialStatusCommand.Response` | Returns the status for the specified credential. |

### getCredentialStatusBatchable

```
fun getCredentialStatusBatchable(
    credential: DoorLockTrait.CredentialStruct
): BatchableCommand<DoorLockTrait.GetCredentialStatusCommand.Response>
```

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.

Retrieve the status of the specified credential.

| Parameters |
|---|---|
| `credential: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.CredentialStruct` | The credential whose status is to be retrieved. |

| Returns |
|---|---|
| `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>` | BatchableCommand |

### getHolidaySchedule

```
suspend fun getHolidaySchedule(holidayIndex: UByte): DoorLockTrait.GetHolidayScheduleCommand.Response
```

Get the holiday schedule for the specified holiday index.

| Parameters |
|---|---|
| `holidayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The unique identifier for the holiday schedule to retrieve. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.GetHolidayScheduleCommand.Response` | Returns the holiday schedule entry for the specified holiday ID. |

### getHolidayScheduleBatchable

```
fun getHolidayScheduleBatchable(holidayIndex: UByte): BatchableCommand<DoorLockTrait.GetHolidayScheduleCommand.Response>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#getHolidaySchedule(kotlin.UByte)` command.

Get the holiday schedule for the specified holiday index.

| Parameters |
|---|---|
| `holidayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The unique identifier for the holiday schedule to retrieve. |

| Returns |
|---|---|
| `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>` | BatchableCommand |

### getUser

```
suspend fun getUser(userIndex: UShort): DoorLockTrait.GetUserCommand.Response
```

Retrieve the user type for a specific user.

| Parameters |
|---|---|
| `userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The unique identifier for the user whose type is to be retrieved. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.GetUserCommand.Response` | Returns the user for the specified `userIndex`. |

### getUserBatchable

```
fun getUserBatchable(userIndex: UShort): BatchableCommand<DoorLockTrait.GetUserCommand.Response>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#getUser(kotlin.UShort)` command.

Retrieve the user type for a specific user.

| Parameters |
|---|---|
| `userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The unique identifier for the user whose type is to be retrieved. |

| Returns |
|---|---|
| `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>` | BatchableCommand |

### getWeekDaySchedule

```
suspend fun getWeekDaySchedule(weekDayIndex: UByte, userIndex: UShort): DoorLockTrait.GetWeekDayScheduleCommand.Response
```

Retrieve the weekly schedule for the specified user.

Week day schedules are used to restrict access to a specified time window on certain days of the week. The schedule is repeated each week.

| Parameters |
|---|---|
| `weekDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The unique identifier for the week day schedule to retrieve. |
| `userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The unique identifier for the user whose week day schedule is to be retrieved. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.GetWeekDayScheduleCommand.Response` | Returns the weekly repeating schedule data for the specified schedule index. |

### getWeekDayScheduleBatchable

```
fun getWeekDayScheduleBatchable(weekDayIndex: UByte, userIndex: UShort): BatchableCommand<DoorLockTrait.GetWeekDayScheduleCommand.Response>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#getWeekDaySchedule(kotlin.UByte,kotlin.UShort)` command.

Retrieve the weekly schedule for the specified user.

Week day schedules are used to restrict access to a specified time window on certain days of the week. The schedule is repeated each week.

| Parameters |
|---|---|
| `weekDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The unique identifier for the week day schedule to retrieve. |
| `userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The unique identifier for the user whose week day schedule is to be retrieved. |

| Returns |
|---|---|
| `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>` | BatchableCommand |

### getYearDaySchedule

```
suspend fun getYearDaySchedule(yearDayIndex: UByte, userIndex: UShort): DoorLockTrait.GetYearDayScheduleCommand.Response
```

Retrieve the specified year day schedule for the specified user.

Year day schedules are used to restrict access to a specified date and time window.

| Parameters |
|---|---|
| `yearDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The unique identifier for the year day schedule to be retrieved. |
| `userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The unique identifier for the user whose year day schedule is to be retrieved. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.GetYearDayScheduleCommand.Response` | Returns the year day schedule data for the specified schedule and user indexes. |

### getYearDayScheduleBatchable

```
fun getYearDayScheduleBatchable(yearDayIndex: UByte, userIndex: UShort): BatchableCommand<DoorLockTrait.GetYearDayScheduleCommand.Response>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#getYearDaySchedule(kotlin.UByte,kotlin.UShort)` command.

Retrieve the specified year day schedule for the specified user.

Year day schedules are used to restrict access to a specified date and time window.

| Parameters |
|---|---|
| `yearDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The unique identifier for the year day schedule to be retrieved. |
| `userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The unique identifier for the user whose year day schedule is to be retrieved. |

| Returns |
|---|---|
| `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>` | BatchableCommand |

### lockDoor

```
suspend fun lockDoor(optionalArgs: DoorLockTrait.LockDoorCommand.OptionalArgs.() -> Unit = {}): Unit
```

Lock the door.

| Parameters |
|---|---|
| `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 = {}` | Receiver for the optional arguments of this command |

### lockDoorBatchable

```
fun lockDoorBatchable(optionalArgs: DoorLockTrait.LockDoorCommand.OptionalArgs.() -> Unit = {}): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#lockDoor(kotlin.Function1)` command.

Lock the door.

| Parameters |
|---|---|
| `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 = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### setAliroReaderConfig

```
suspend fun setAliroReaderConfig(
    signingKey: ByteArray,
    verificationKey: ByteArray,
    groupIdentifier: ByteArray,
    optionalArgs: DoorLockTrait.SetAliroReaderConfigCommand.OptionalArgs.() -> Unit = {}
): Unit
```

### setAliroReaderConfigBatchable

```
fun setAliroReaderConfigBatchable(
    signingKey: ByteArray,
    verificationKey: ByteArray,
    groupIdentifier: ByteArray,
    optionalArgs: DoorLockTrait.SetAliroReaderConfigCommand.OptionalArgs.() -> Unit = {}
): BatchableCommand<Unit>
```

### setCredential

```
suspend fun setCredential(
    operationType: DoorLockTrait.DataOperationTypeEnum,
    credential: DoorLockTrait.CredentialStruct,
    credentialData: ByteArray,
    userIndex: UShort?,
    userStatus: DoorLockTrait.UserStatusEnum?,
    userType: DoorLockTrait.UserTypeEnum?
): DoorLockTrait.SetCredentialCommand.Response
```

Set a credential into the lock for a new or existing user, or for a programming user.

| Parameters |
|---|---|
| `operationType: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DataOperationTypeEnum` | The operation to be performed. |
| `credential: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.CredentialStruct` | The credential to be set. |
| `credentialData: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html` | The credential data to set for the credential being added or modified. |
| `userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | The unique identifier for the user record that corresponds to the credential being added or modified. |
| `userStatus: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.UserStatusEnum?` | The user status to use in the new user record if a new user is being created. Valid values are defined by `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 user type to use in the new user record if a new user is being created. Valid values are defined by `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.UserTypeEnum`. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.SetCredentialCommand.Response` | The status for setting the specified credential. |

### setCredentialBatchable

```
fun setCredentialBatchable(
    operationType: DoorLockTrait.DataOperationTypeEnum,
    credential: DoorLockTrait.CredentialStruct,
    credentialData: ByteArray,
    userIndex: UShort?,
    userStatus: DoorLockTrait.UserStatusEnum?,
    userType: DoorLockTrait.UserTypeEnum?
): BatchableCommand<DoorLockTrait.SetCredentialCommand.Response>
```

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.

Set a credential into the lock for a new or existing user, or for a programming user.

| Parameters |
|---|---|
| `operationType: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DataOperationTypeEnum` | The operation to be performed. |
| `credential: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.CredentialStruct` | The credential to be set. |
| `credentialData: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-byte-array/index.html` | The credential data to set for the credential being added or modified. |
| `userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html?` | The unique identifier for the user record that corresponds to the credential being added or modified. |
| `userStatus: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.UserStatusEnum?` | The user status to use in the new user record if a new user is being created. Valid values are defined by `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 user type to use in the new user record if a new user is being created. Valid values are defined by `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.UserTypeEnum`. |

| Returns |
|---|---|
| `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>` | BatchableCommand |

### setHolidaySchedule

```
suspend fun setHolidaySchedule(
    holidayIndex: UByte,
    localStartTime: UInt,
    localEndTime: UInt,
    operatingMode: DoorLockTrait.OperatingModeEnum
): Unit
```

Set the holiday schedule by specifying the local start and end time with respect to a specific lock operating mode.

| Parameters |
|---|---|
| `holidayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The unique identifier for the holiday whose schedule is to be set. |
| `localStartTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html` | The starting time for the holiday schedule in Epoch Time in seconds with local time offset based on the local timezone and DST offset on the day represented by the value. |
| `localEndTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html` | The ending time for the holiday schedule in Epoch Time in seconds with local time offset based on the local timezone and DST offset on the day represented by the value. |
| `operatingMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.OperatingModeEnum` | The operating mode to use for the specified holiday schedule start and end time. Valid values are defined by `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.OperatingModeEnum`. |

### setHolidayScheduleBatchable

```
fun setHolidayScheduleBatchable(
    holidayIndex: UByte,
    localStartTime: UInt,
    localEndTime: UInt,
    operatingMode: DoorLockTrait.OperatingModeEnum
): BatchableCommand<Unit>
```

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.

Set the holiday schedule by specifying the local start and end time with respect to a specific lock operating mode.

| Parameters |
|---|---|
| `holidayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The unique identifier for the holiday whose schedule is to be set. |
| `localStartTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html` | The starting time for the holiday schedule in Epoch Time in seconds with local time offset based on the local timezone and DST offset on the day represented by the value. |
| `localEndTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html` | The ending time for the holiday schedule in Epoch Time in seconds with local time offset based on the local timezone and DST offset on the day represented by the value. |
| `operatingMode: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.OperatingModeEnum` | The operating mode to use for the specified holiday schedule start and end time. Valid values are defined by `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.OperatingModeEnum`. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### setUser

```
suspend fun setUser(
    operationType: DoorLockTrait.DataOperationTypeEnum,
    userIndex: UShort,
    userName: String?,
    userUniqueId: UInt?,
    userStatus: DoorLockTrait.UserStatusEnum?,
    userType: DoorLockTrait.UserTypeEnum?,
    credentialRule: DoorLockTrait.CredentialRuleEnum?
): Unit
```

Set the user on the lock.

| Parameters |
|---|---|
| `operationType: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DataOperationTypeEnum` | The operation to perform. Valid values are defined by `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` | The unique identifier for the user to set on the lock. |
| `userName: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html?` | The user name of the user to set on the lock. |
| `userStatus: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.UserStatusEnum?` | The status of the user to set on the lock. Valid values are defined by `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 type of the user. Valid values are defined by `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 credential rule. Valid values are defined by `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.CredentialRuleEnum`. |

### setUserBatchable

```
fun setUserBatchable(
    operationType: DoorLockTrait.DataOperationTypeEnum,
    userIndex: UShort,
    userName: String?,
    userUniqueId: UInt?,
    userStatus: DoorLockTrait.UserStatusEnum?,
    userType: DoorLockTrait.UserTypeEnum?,
    credentialRule: DoorLockTrait.CredentialRuleEnum?
): BatchableCommand<Unit>
```

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.

Set the user on the lock.

| Parameters |
|---|---|
| `operationType: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DataOperationTypeEnum` | The operation to perform. Valid values are defined by `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` | The unique identifier for the user to set on the lock. |
| `userName: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html?` | The user name of the user to set on the lock. |
| `userStatus: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.UserStatusEnum?` | The status of the user to set on the lock. Valid values are defined by `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 type of the user. Valid values are defined by `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 credential rule. Valid values are defined by `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.CredentialRuleEnum`. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### setWeekDaySchedule

```
suspend fun setWeekDaySchedule(
    weekDayIndex: UByte,
    userIndex: UShort,
    daysMask: DoorLockTrait.DaysMaskMap,
    startHour: UByte,
    startMinute: UByte,
    endHour: UByte,
    endMinute: UByte
): Unit
```

Set a weekly repeating schedule for the specified user.

| Parameters |
|---|---|
| `weekDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The unique identifier for the week day. |
| `userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The unique identifier for the user for whom the repeating schedule is being set. |
| `daysMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DaysMaskMap` | The days that constitute the repeating schedule. Valid values are defined by `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` | The start hour of the repeating event. |
| `startMinute: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The start minute of the repeating event. |
| `endHour: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The end hour of the repeating event. |
| `endMinute: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The end minute of the repeating event. |

### setWeekDayScheduleBatchable

```
fun setWeekDayScheduleBatchable(
    weekDayIndex: UByte,
    userIndex: UShort,
    daysMask: DoorLockTrait.DaysMaskMap,
    startHour: UByte,
    startMinute: UByte,
    endHour: UByte,
    endMinute: UByte
): BatchableCommand<Unit>
```

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.

Set a weekly repeating schedule for the specified user.

| Parameters |
|---|---|
| `weekDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The unique identifier for the week day. |
| `userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The unique identifier for the user for whom the repeating schedule is being set. |
| `daysMask: https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockTrait.DaysMaskMap` | The days that constitute the repeating schedule. Valid values are defined by `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` | The start hour of the repeating event. |
| `startMinute: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The start minute of the repeating event. |
| `endHour: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The end hour of the repeating event. |
| `endMinute: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The end minute of the repeating event. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### setYearDaySchedule

```
suspend fun setYearDaySchedule(
    yearDayIndex: UByte,
    userIndex: UShort,
    localStartTime: UInt,
    localEndTime: UInt
): Unit
```

Set a time-specific schedule ID for a specified user.

| Parameters |
|---|---|
| `yearDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The unique identifier for the year day schedule. |
| `userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The unique identifier for the user for whom the repeating schedule is being set. |
| `localStartTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html` | The starting time for the year day schedule in Epoch Time in seconds with local time offset based on the local timezone and DST offset on the day represented by the value. |
| `localEndTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html` | The ending time for the year day schedule in Epoch Time in seconds with local time offset based on the local timezone and DST offset on the day represented by the value. |

### setYearDayScheduleBatchable

```
fun setYearDayScheduleBatchable(
    yearDayIndex: UByte,
    userIndex: UShort,
    localStartTime: UInt,
    localEndTime: UInt
): BatchableCommand<Unit>
```

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.

Set a time-specific schedule ID for a specified user.

| Parameters |
|---|---|
| `yearDayIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-byte/index.html` | The unique identifier for the year day schedule. |
| `userIndex: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The unique identifier for the user for whom the repeating schedule is being set. |
| `localStartTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html` | The starting time for the year day schedule in Epoch Time in seconds with local time offset based on the local timezone and DST offset on the day represented by the value. |
| `localEndTime: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-int/index.html` | The ending time for the year day schedule in Epoch Time in seconds with local time offset based on the local timezone and DST offset on the day represented by the value. |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### unboltDoor

```
suspend fun unboltDoor(optionalArgs: DoorLockTrait.UnboltDoorCommand.OptionalArgs.() -> Unit = {}): Unit
```

Disengage the deadbolt.

| Parameters |
|---|---|
| `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 = {}` | Receiver for the optional arguments of this command |

### unboltDoorBatchable

```
fun unboltDoorBatchable(optionalArgs: DoorLockTrait.UnboltDoorCommand.OptionalArgs.() -> Unit = {}): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#unboltDoor(kotlin.Function1)` command.

Disengage the deadbolt.

| Parameters |
|---|---|
| `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 = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### unlockDoor

```
suspend fun unlockDoor(optionalArgs: DoorLockTrait.UnlockDoorCommand.OptionalArgs.() -> Unit = {}): Unit
```

Unlock the door.

| Parameters |
|---|---|
| `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 = {}` | Receiver for the optional arguments of this command |

### unlockDoorBatchable

```
fun unlockDoorBatchable(optionalArgs: DoorLockTrait.UnlockDoorCommand.OptionalArgs.() -> Unit = {}): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#unlockDoor(kotlin.Function1)` command.

Unlock the door.

| Parameters |
|---|---|
| `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 = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |

### unlockWithTimeout

```
suspend fun unlockWithTimeout(timeout: UShort, optionalArgs: DoorLockTrait.UnlockWithTimeoutCommand.OptionalArgs.() -> Unit = {}): Unit
```

Unlock the door with a timeout parameter. After the timeout, the door automatically relocks.

| Parameters |
|---|---|
| `timeout: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The number of seconds to wait before relocking the door lock. |
| `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 = {}` | Receiver for the optional arguments of this command |

### unlockWithTimeoutBatchable

```
fun unlockWithTimeoutBatchable(timeout: UShort, optionalArgs: DoorLockTrait.UnlockWithTimeoutCommand.OptionalArgs.() -> Unit = {}): BatchableCommand<Unit>
```

The batchable version of `https://developers.home.google.com/reference/kotlin/com/google/home/matter/standard/DoorLockCommands#unlockWithTimeout(kotlin.UShort,kotlin.Function1)` command.

Unlock the door with a timeout parameter. After the timeout, the door automatically relocks.

| Parameters |
|---|---|
| `timeout: https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-u-short/index.html` | The number of seconds to wait before relocking the door lock. |
| `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 = {}` | Receiver for the optional arguments of this command |

| Returns |
|---|---|
| `https://developers.home.google.com/reference/kotlin/com/google/home/BatchableCommand<https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-unit/index.html>` | BatchableCommand |