DoorLockCommands

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

Known direct subclasses

DoorLock

DoorLock

API for the DoorLock trait.

Summary

Public functions
`suspend Unit`	`clearAliroReaderConfig()`
`BatchableCommand<Unit>`	`clearAliroReaderConfigBatchable()`
`suspend Unit`	`clearCredential(credential: DoorLockTrait.CredentialStruct?)` Clear a single credential, one type of credential, or all credentials except `ProgrammingPIN` credentials.
`BatchableCommand<Unit>`	`clearCredentialBatchable(credential: DoorLockTrait.CredentialStruct?)` The batchable version of `clearCredential` command.
`suspend Unit`	`clearHolidaySchedule(holidayIndex: UByte)` Clear the specified holiday schedule, or all holiday schedules.
`BatchableCommand<Unit>`	`clearHolidayScheduleBatchable(holidayIndex: UByte)` The batchable version of `clearHolidaySchedule` command.
`suspend Unit`	`clearUser(userIndex: UShort)` Clear the specified user.
`BatchableCommand<Unit>`	`clearUserBatchable(userIndex: UShort)` The batchable version of `clearUser` command.
`suspend Unit`	`clearWeekDaySchedule(weekDayIndex: UByte, userIndex: UShort)` Clear the specified week day schedule or all week day schedules for the specific user.
`BatchableCommand<Unit>`	`clearWeekDayScheduleBatchable(weekDayIndex: UByte, userIndex: UShort)` The batchable version of `clearWeekDaySchedule` command.
`suspend Unit`	`clearYearDaySchedule(yearDayIndex: UByte, userIndex: UShort)` Clear the specified year day schedule, or all year day schedules for the specific user.
`BatchableCommand<Unit>`	`clearYearDayScheduleBatchable(yearDayIndex: UByte, userIndex: UShort)` The batchable version of `clearYearDaySchedule` command.
`suspend DoorLockTrait.GetCredentialStatusCommand.Response`	`getCredentialStatus(credential: DoorLockTrait.CredentialStruct)` Retrieve the status of the specified credential.
`BatchableCommand<DoorLockTrait.GetCredentialStatusCommand.Response>`	`getCredentialStatusBatchable( credential: DoorLockTrait.CredentialStruct )` The batchable version of `getCredentialStatus` command.
`suspend DoorLockTrait.GetHolidayScheduleCommand.Response`	`getHolidaySchedule(holidayIndex: UByte)` Get the holiday schedule for the specified holiday index.
`BatchableCommand<DoorLockTrait.GetHolidayScheduleCommand.Response>`	`getHolidayScheduleBatchable(holidayIndex: UByte)` The batchable version of `getHolidaySchedule` command.
`suspend DoorLockTrait.GetUserCommand.Response`	`getUser(userIndex: UShort)` Retrieve the user type for a specific user.
`BatchableCommand<DoorLockTrait.GetUserCommand.Response>`	`getUserBatchable(userIndex: UShort)` The batchable version of `getUser` command.
`suspend DoorLockTrait.GetWeekDayScheduleCommand.Response`	`getWeekDaySchedule(weekDayIndex: UByte, userIndex: UShort)` Retrieve the weekly schedule for the specified user.
`BatchableCommand<DoorLockTrait.GetWeekDayScheduleCommand.Response>`	`getWeekDayScheduleBatchable(weekDayIndex: UByte, userIndex: UShort)` The batchable version of `getWeekDaySchedule` command.
`suspend DoorLockTrait.GetYearDayScheduleCommand.Response`	`getYearDaySchedule(yearDayIndex: UByte, userIndex: UShort)` Retrieve the specified year day schedule for the specified user.
`BatchableCommand<DoorLockTrait.GetYearDayScheduleCommand.Response>`	`getYearDayScheduleBatchable(yearDayIndex: UByte, userIndex: UShort)` The batchable version of `getYearDaySchedule` command.
`suspend Unit`	`lockDoor(optionalArgs: DoorLockTrait.LockDoorCommand.OptionalArgs.() -> Unit)` Lock the door.
`BatchableCommand<Unit>`	`lockDoorBatchable(optionalArgs: DoorLockTrait.LockDoorCommand.OptionalArgs.() -> Unit)` The batchable version of `lockDoor` command.
`suspend Unit`	`setAliroReaderConfig( signingKey: ByteArray, verificationKey: ByteArray, groupIdentifier: ByteArray, optionalArgs: DoorLockTrait.SetAliroReaderConfigCommand.OptionalArgs.() -> Unit )`
`BatchableCommand<Unit>`	`setAliroReaderConfigBatchable( signingKey: ByteArray, verificationKey: ByteArray, groupIdentifier: ByteArray, optionalArgs: DoorLockTrait.SetAliroReaderConfigCommand.OptionalArgs.() -> Unit )`
`suspend DoorLockTrait.SetCredentialCommand.Response`	`setCredential( operationType: DoorLockTrait.DataOperationTypeEnum, credential: DoorLockTrait.CredentialStruct, credentialData: ByteArray, userIndex: UShort?, userStatus: DoorLockTrait.UserStatusEnum?, userType: DoorLockTrait.UserTypeEnum? )` Set a credential into the lock for a new or existing user, or for a programming user.
`BatchableCommand<DoorLockTrait.SetCredentialCommand.Response>`	`setCredentialBatchable( operationType: DoorLockTrait.DataOperationTypeEnum, credential: DoorLockTrait.CredentialStruct, credentialData: ByteArray, userIndex: UShort?, userStatus: DoorLockTrait.UserStatusEnum?, userType: DoorLockTrait.UserTypeEnum? )` The batchable version of `setCredential` command.
`suspend Unit`	`setHolidaySchedule( holidayIndex: UByte, localStartTime: UInt, localEndTime: UInt, operatingMode: DoorLockTrait.OperatingModeEnum )` Set the holiday schedule by specifying the local start and end time with respect to a specific lock operating mode.
`BatchableCommand<Unit>`	`setHolidayScheduleBatchable( holidayIndex: UByte, localStartTime: UInt, localEndTime: UInt, operatingMode: DoorLockTrait.OperatingModeEnum )` The batchable version of `setHolidaySchedule` command.
`suspend Unit`	`setUser( operationType: DoorLockTrait.DataOperationTypeEnum, userIndex: UShort, userName: String?, userUniqueId: UInt?, userStatus: DoorLockTrait.UserStatusEnum?, userType: DoorLockTrait.UserTypeEnum?, credentialRule: DoorLockTrait.CredentialRuleEnum? )` Set the user on the lock.
`BatchableCommand<Unit>`	`setUserBatchable( operationType: DoorLockTrait.DataOperationTypeEnum, userIndex: UShort, userName: String?, userUniqueId: UInt?, userStatus: DoorLockTrait.UserStatusEnum?, userType: DoorLockTrait.UserTypeEnum?, credentialRule: DoorLockTrait.CredentialRuleEnum? )` The batchable version of `setUser` command.
`suspend Unit`	`setWeekDaySchedule( weekDayIndex: UByte, userIndex: UShort, daysMask: DoorLockTrait.DaysMaskMap, startHour: UByte, startMinute: UByte, endHour: UByte, endMinute: UByte )` Set a weekly repeating schedule for the specified user.
`BatchableCommand<Unit>`	`setWeekDayScheduleBatchable( weekDayIndex: UByte, userIndex: UShort, daysMask: DoorLockTrait.DaysMaskMap, startHour: UByte, startMinute: UByte, endHour: UByte, endMinute: UByte )` The batchable version of `setWeekDaySchedule` command.
`suspend Unit`	`setYearDaySchedule( yearDayIndex: UByte, userIndex: UShort, localStartTime: UInt, localEndTime: UInt )` Set a time-specific schedule ID for a specified user.
`BatchableCommand<Unit>`	`setYearDayScheduleBatchable( yearDayIndex: UByte, userIndex: UShort, localStartTime: UInt, localEndTime: UInt )` The batchable version of `setYearDaySchedule` command.
`suspend Unit`	`unboltDoor(optionalArgs: DoorLockTrait.UnboltDoorCommand.OptionalArgs.() -> Unit)` Disengage the deadbolt.
`BatchableCommand<Unit>`	`unboltDoorBatchable(optionalArgs: DoorLockTrait.UnboltDoorCommand.OptionalArgs.() -> Unit)` The batchable version of `unboltDoor` command.
`suspend Unit`	`unlockDoor(optionalArgs: DoorLockTrait.UnlockDoorCommand.OptionalArgs.() -> Unit)` Unlock the door.
`BatchableCommand<Unit>`	`unlockDoorBatchable(optionalArgs: DoorLockTrait.UnlockDoorCommand.OptionalArgs.() -> Unit)` The batchable version of `unlockDoor` command.
`suspend Unit`	`unlockWithTimeout(timeout: UShort, optionalArgs: DoorLockTrait.UnlockWithTimeoutCommand.OptionalArgs.() -> Unit)` Unlock the door with a timeout parameter.
`BatchableCommand<Unit>`	`unlockWithTimeoutBatchable(timeout: UShort, optionalArgs: DoorLockTrait.UnlockWithTimeoutCommand.OptionalArgs.() -> Unit)` The batchable version of `unlockWithTimeout` 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: DoorLockTrait.CredentialStruct?`	The credential to be cleared.

clearCredentialBatchable

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

The batchable version of clearCredential command.

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

Parameters
`credential: DoorLockTrait.CredentialStruct?`	The credential to be cleared.

Returns
`BatchableCommand<Unit>`	BatchableCommand

clearHolidaySchedule

suspend fun clearHolidaySchedule(holidayIndex: UByte): Unit

Clear the specified holiday schedule, or all holiday schedules.

Parameters
`holidayIndex: UByte`	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 clearHolidaySchedule command.

Clear the specified holiday schedule, or all holiday schedules.

Parameters
`holidayIndex: UByte`	The unique identifier for the holiday schedule to clear. `0xFE` clears all holiday schedules.

Returns
`BatchableCommand<Unit>`	BatchableCommand

clearUser

suspend fun clearUser(userIndex: UShort): Unit

Clear the specified user.

Parameters
`userIndex: UShort`	The unique identifier for the user to clear. `0xFFFE` clears all users.

clearUserBatchable

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

The batchable version of clearUser command.

Clear the specified user.

Parameters
`userIndex: UShort`	The unique identifier for the user to clear. `0xFFFE` clears all users.

Returns
`BatchableCommand<Unit>`	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: UByte`	The unique identifier for the week day schedule to clear. `0xFE` clears all week day schedules for the specified user.
`userIndex: UShort`	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 clearWeekDaySchedule 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: UByte`	The unique identifier for the week day schedule to clear. `0xFE` clears all week day schedules for the specified user.
`userIndex: UShort`	The unique identifier for the user whose schedule is to be cleared.

Returns
`BatchableCommand<Unit>`	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: UByte`	The unique identifier for the year day schedule to clear. `0xFE` clears all year day schedules for the specified user.
`userIndex: UShort`	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 clearYearDaySchedule 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: UByte`	The unique identifier for the year day schedule to clear. `0xFE` clears all year day schedules for the specified user.
`userIndex: UShort`	The unique identifier for the user whose year day schedule is to be cleared.

Returns
`BatchableCommand<Unit>`	BatchableCommand

getCredentialStatus

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

Retrieve the status of the specified credential.

Parameters
`credential: DoorLockTrait.CredentialStruct`	The credential whose status is to be retrieved.

Returns
`DoorLockTrait.GetCredentialStatusCommand.Response`	Returns the status for the specified credential.

getCredentialStatusBatchable

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

The batchable version of getCredentialStatus command.

Retrieve the status of the specified credential.

Parameters
`credential: DoorLockTrait.CredentialStruct`	The credential whose status is to be retrieved.

Returns
`BatchableCommand<DoorLockTrait.GetCredentialStatusCommand.Response>`	BatchableCommand

getHolidaySchedule

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

Get the holiday schedule for the specified holiday index.

Parameters
`holidayIndex: UByte`	The unique identifier for the holiday schedule to retrieve.

Returns
`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 getHolidaySchedule command.

Get the holiday schedule for the specified holiday index.

Parameters
`holidayIndex: UByte`	The unique identifier for the holiday schedule to retrieve.

Returns
`BatchableCommand<DoorLockTrait.GetHolidayScheduleCommand.Response>`	BatchableCommand

getUser

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

Retrieve the user type for a specific user.

Parameters
`userIndex: UShort`	The unique identifier for the user whose type is to be retrieved.

Returns
`DoorLockTrait.GetUserCommand.Response`	Returns the user for the specified `userIndex`.

getUserBatchable

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

The batchable version of getUser command.

Retrieve the user type for a specific user.

Parameters
`userIndex: UShort`	The unique identifier for the user whose type is to be retrieved.

Returns
`BatchableCommand<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: UByte`	The unique identifier for the week day schedule to retrieve.
`userIndex: UShort`	The unique identifier for the user whose week day schedule is to be retrieved.

Returns
`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 getWeekDaySchedule 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: UByte`	The unique identifier for the week day schedule to retrieve.
`userIndex: UShort`	The unique identifier for the user whose week day schedule is to be retrieved.

Returns
`BatchableCommand<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: UByte`	The unique identifier for the year day schedule to be retrieved.
`userIndex: UShort`	The unique identifier for the user whose year day schedule is to be retrieved.

Returns
`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 getYearDaySchedule 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: UByte`	The unique identifier for the year day schedule to be retrieved.
`userIndex: UShort`	The unique identifier for the user whose year day schedule is to be retrieved.

Returns
`BatchableCommand<DoorLockTrait.GetYearDayScheduleCommand.Response>`	BatchableCommand

lockDoor

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

Lock the door.

Parameters
`optionalArgs: DoorLockTrait.LockDoorCommand.OptionalArgs.() -> Unit = {}`	Receiver for the optional arguments of this command

lockDoorBatchable

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

The batchable version of lockDoor command.

Lock the door.

Parameters
`optionalArgs: DoorLockTrait.LockDoorCommand.OptionalArgs.() -> Unit = {}`	Receiver for the optional arguments of this command

Returns
`BatchableCommand<Unit>`	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: DoorLockTrait.DataOperationTypeEnum`	The operation to be performed.
`credential: DoorLockTrait.CredentialStruct`	The credential to be set.
`credentialData: ByteArray`	The credential data to set for the credential being added or modified.
`userIndex: UShort?`	The unique identifier for the user record that corresponds to the credential being added or modified.
`userStatus: DoorLockTrait.UserStatusEnum?`	The user status to use in the new user record if a new user is being created. Valid values are defined by `UserStatusEnum`.
`userType: DoorLockTrait.UserTypeEnum?`	The user type to use in the new user record if a new user is being created. Valid values are defined by `UserTypeEnum`.

Returns
`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 setCredential command.

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

Parameters
`operationType: DoorLockTrait.DataOperationTypeEnum`	The operation to be performed.
`credential: DoorLockTrait.CredentialStruct`	The credential to be set.
`credentialData: ByteArray`	The credential data to set for the credential being added or modified.
`userIndex: UShort?`	The unique identifier for the user record that corresponds to the credential being added or modified.
`userStatus: DoorLockTrait.UserStatusEnum?`	The user status to use in the new user record if a new user is being created. Valid values are defined by `UserStatusEnum`.
`userType: DoorLockTrait.UserTypeEnum?`	The user type to use in the new user record if a new user is being created. Valid values are defined by `UserTypeEnum`.

Returns
`BatchableCommand<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: UByte`	The unique identifier for the holiday whose schedule is to be set.
`localStartTime: UInt`	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: UInt`	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: DoorLockTrait.OperatingModeEnum`	The operating mode to use for the specified holiday schedule start and end time. Valid values are defined by `OperatingModeEnum`.

setHolidayScheduleBatchable

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

The batchable version of setHolidaySchedule command.

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

Parameters
`holidayIndex: UByte`	The unique identifier for the holiday whose schedule is to be set.
`localStartTime: UInt`	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: UInt`	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: DoorLockTrait.OperatingModeEnum`	The operating mode to use for the specified holiday schedule start and end time. Valid values are defined by `OperatingModeEnum`.

Returns
`BatchableCommand<Unit>`	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: DoorLockTrait.DataOperationTypeEnum`	The operation to perform. Valid values are defined by `DataOperationTypeEnum`.
`userIndex: UShort`	The unique identifier for the user to set on the lock.
`userName: String?`	The user name of the user to set on the lock.
`userStatus: DoorLockTrait.UserStatusEnum?`	The status of the user to set on the lock. Valid values are defined by `UserStatusEnum`.
`userType: DoorLockTrait.UserTypeEnum?`	The type of the user. Valid values are defined by `UserTypeEnum`.
`credentialRule: DoorLockTrait.CredentialRuleEnum?`	The credential rule. Valid values are defined by `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 setUser command.

Set the user on the lock.

Parameters
`operationType: DoorLockTrait.DataOperationTypeEnum`	The operation to perform. Valid values are defined by `DataOperationTypeEnum`.
`userIndex: UShort`	The unique identifier for the user to set on the lock.
`userName: String?`	The user name of the user to set on the lock.
`userStatus: DoorLockTrait.UserStatusEnum?`	The status of the user to set on the lock. Valid values are defined by `UserStatusEnum`.
`userType: DoorLockTrait.UserTypeEnum?`	The type of the user. Valid values are defined by `UserTypeEnum`.
`credentialRule: DoorLockTrait.CredentialRuleEnum?`	The credential rule. Valid values are defined by `CredentialRuleEnum`.

Returns
`BatchableCommand<Unit>`	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: UByte`	The unique identifier for the week day.
`userIndex: UShort`	The unique identifier for the user for whom the repeating schedule is being set.
`daysMask: DoorLockTrait.DaysMaskMap`	The days that constitute the repeating schedule. Valid values are defined by `DaysMaskMap`.
`startHour: UByte`	The start hour of the repeating event.
`startMinute: UByte`	The start minute of the repeating event.
`endHour: UByte`	The end hour of the repeating event.
`endMinute: UByte`	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 setWeekDaySchedule command.

Set a weekly repeating schedule for the specified user.

Parameters
`weekDayIndex: UByte`	The unique identifier for the week day.
`userIndex: UShort`	The unique identifier for the user for whom the repeating schedule is being set.
`daysMask: DoorLockTrait.DaysMaskMap`	The days that constitute the repeating schedule. Valid values are defined by `DaysMaskMap`.
`startHour: UByte`	The start hour of the repeating event.
`startMinute: UByte`	The start minute of the repeating event.
`endHour: UByte`	The end hour of the repeating event.
`endMinute: UByte`	The end minute of the repeating event.

Returns
`BatchableCommand<Unit>`	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: UByte`	The unique identifier for the year day schedule.
`userIndex: UShort`	The unique identifier for the user for whom the repeating schedule is being set.
`localStartTime: UInt`	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: UInt`	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 setYearDaySchedule command.

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

Parameters
`yearDayIndex: UByte`	The unique identifier for the year day schedule.
`userIndex: UShort`	The unique identifier for the user for whom the repeating schedule is being set.
`localStartTime: UInt`	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: UInt`	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
`BatchableCommand<Unit>`	BatchableCommand

unboltDoor

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

Disengage the deadbolt.

Parameters
`optionalArgs: DoorLockTrait.UnboltDoorCommand.OptionalArgs.() -> Unit = {}`	Receiver for the optional arguments of this command

unboltDoorBatchable

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

The batchable version of unboltDoor command.

Disengage the deadbolt.

Parameters
`optionalArgs: DoorLockTrait.UnboltDoorCommand.OptionalArgs.() -> Unit = {}`	Receiver for the optional arguments of this command

Returns
`BatchableCommand<Unit>`	BatchableCommand

unlockDoor

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

Unlock the door.

Parameters
`optionalArgs: DoorLockTrait.UnlockDoorCommand.OptionalArgs.() -> Unit = {}`	Receiver for the optional arguments of this command

unlockDoorBatchable

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

The batchable version of unlockDoor command.

Unlock the door.

Parameters
`optionalArgs: DoorLockTrait.UnlockDoorCommand.OptionalArgs.() -> Unit = {}`	Receiver for the optional arguments of this command

Returns
`BatchableCommand<Unit>`	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: UShort`	The number of seconds to wait before relocking the door lock.
`optionalArgs: DoorLockTrait.UnlockWithTimeoutCommand.OptionalArgs.() -> Unit = {}`	Receiver for the optional arguments of this command

unlockWithTimeoutBatchable

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

The batchable version of unlockWithTimeout command.

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

Parameters
`timeout: UShort`	The number of seconds to wait before relocking the door lock.
`optionalArgs: DoorLockTrait.UnlockWithTimeoutCommand.OptionalArgs.() -> Unit = {}`	Receiver for the optional arguments of this command

Returns
`BatchableCommand<Unit>`	BatchableCommand