DoorLockTrait.GetWeekDayScheduleCommand.Response
class DoorLockTrait.GetWeekDayScheduleCommand.Response : ClusterStruct
Returns the weekly repeating schedule data for the specified schedule index.
Summary
Nested types |
|---|
@HomeExperimentalApiDescriptor enum for this command's request fields. |
Public constructors |
|---|
Response(Creates a response payload from the GetWeekDaySchedule command. |
Public functions |
|
|---|---|
open StructDescriptor |
Returns the descriptor for the struct. |
open Any? |
@HomeExperimentalApiReturns the value of the field for the given tag ID. |
Public properties |
|
|---|---|
DoorLockTrait.DaysMaskMap? |
The days of the week in the week day schedule. |
UByte? |
This indicates the ending hour for the week day schedule. |
UByte? |
The ending minute for the week day schedule. |
UByte? |
The starting hour for the week day schedule. |
UByte? |
The starting minute for the week day schedule. |
DoorLockTrait.DlStatus |
The status of the |
UShort |
The unique identifier for the user whose week day schedule is to be retrieved. |
UByte |
The unique identifier for the week day schedule being retrieved. |
Public constructors
Response
Response(
weekDayIndex: UByte,
userIndex: UShort,
status: DoorLockTrait.DlStatus = DlStatus.Success,
daysMask: DoorLockTrait.DaysMaskMap? = null,
startHour: UByte? = null,
startMinute: UByte? = null,
endHour: UByte? = null,
endMinute: UByte? = null
)
Creates a response payload from the GetWeekDaySchedule command.
Public functions
getDescriptor
@HomeExperimentalApi
open fun getDescriptor(): StructDescriptor
Returns the descriptor for the struct.
getFieldValueById
@HomeExperimentalApi
open fun getFieldValueById(tagId: UInt): Any?
Returns the value of the field for the given tag ID.
Public properties
userIndex
val userIndex: UShort
The unique identifier for the user whose week day schedule is to be retrieved.
weekDayIndex
val weekDayIndex: UByte
The unique identifier for the week day schedule being retrieved.