DoorLockTrait.GetHolidayScheduleCommand.Response

class DoorLockTrait.GetHolidayScheduleCommand.Response


Returns the holiday schedule entry for the specified holiday ID.

Summary

Public constructors

Response(
    holidayIndex: UByte,
    status: DoorLockTrait.DlStatus,
    localStartTime: UInt?,
    localEndTime: UInt?,
    operatingMode: DoorLockTrait.OperatingModeEnum?
)

Creates a response payload from the GetHolidaySchedule command.

Public properties

UByte

The index of the holiday.

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.

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.

DoorLockTrait.OperatingModeEnum?

The operating mode to use during this holiday schedule start/end time.

DoorLockTrait.DlStatus

The status of the GetHolidaySchedule command.

Public constructors

Response

Response(
    holidayIndex: UByte,
    status: DoorLockTrait.DlStatus = DlStatus.Success,
    localStartTime: UInt? = null,
    localEndTime: UInt? = null,
    operatingMode: DoorLockTrait.OperatingModeEnum? = null
)

Creates a response payload from the GetHolidaySchedule command.

Public properties

holidayIndex

val holidayIndexUByte

The index of the holiday.

localEndTime

val localEndTimeUInt?

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.

localStartTime

val localStartTimeUInt?

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.

operatingMode

val operatingModeDoorLockTrait.OperatingModeEnum?

The operating mode to use during this holiday schedule start/end time.

status

val statusDoorLockTrait.DlStatus

The status of the GetHolidaySchedule command.