Interface HolidaySchedules

interface HolidaySchedules {
    clearHolidaySchedule(request: DoorLock.ClearHolidayScheduleRequest): MaybePromise;
    getHolidaySchedule(request: DoorLock.GetHolidayScheduleRequest): MaybePromise<DoorLock.GetHolidayScheduleResponse>;
    setHolidaySchedule(request: DoorLock.SetHolidayScheduleRequest): MaybePromise;
}

Index

Methods

clearHolidaySchedule getHolidaySchedule setHolidaySchedule

Methods

clearHolidaySchedule

clearHolidaySchedule(request): MaybePromise
Clears the holiday schedule or all holiday schedules.

† The Holiday Schedule ID is an obsolete field name, use HolidayIndex instead.
Parameters
- request: DoorLock.ClearHolidayScheduleRequest
Returns MaybePromise
See
MatterSpecification.v13.Cluster § 5.2.10.25
- Defined in packages/node/src/behaviors/door-lock/DoorLockInterface.ts:248

getHolidaySchedule

getHolidaySchedule(request): MaybePromise<DoorLock.GetHolidayScheduleResponse>
Get the holiday schedule for the specified index.

† The Holiday Schedule ID is an obsolete field name, use HolidayIndex instead.
Parameters
- request: DoorLock.GetHolidayScheduleRequest
Returns MaybePromise<DoorLock.GetHolidayScheduleResponse>
See
MatterSpecification.v13.Cluster § 5.2.10.23
- Defined in packages/node/src/behaviors/door-lock/DoorLockInterface.ts:239

setHolidaySchedule

setHolidaySchedule(request): MaybePromise
Set the holiday Schedule by specifying local start time and local end time with respect to any Lock Operating Mode.

† The Holiday Schedule ID is an obsolete field name, use HolidayIndex instead. Return status shall be one of the following values:
Parameters
- request: DoorLock.SetHolidayScheduleRequest
Returns MaybePromise
See
MatterSpecification.v13.Cluster § 5.2.10.22
- Defined in packages/node/src/behaviors/door-lock/DoorLockInterface.ts:230