Interface YearDayAccessSchedules

interface YearDayAccessSchedules {
    clearYearDaySchedule(request: DoorLock.ClearYearDayScheduleRequest): MaybePromise;
    getYearDaySchedule(request: DoorLock.GetYearDayScheduleRequest): MaybePromise<DoorLock.GetYearDayScheduleResponse>;
    setYearDaySchedule(request: DoorLock.SetYearDayScheduleRequest): MaybePromise;
}

Index

Methods

clearYearDaySchedule getYearDaySchedule setYearDaySchedule

Methods

clearYearDaySchedule

clearYearDaySchedule(request): MaybePromise
Clears the specific year day schedule or all year day schedules for the specific user.

† The Schedule ID and User ID are obsolete field names, use YearDayIndex and UserIndex instead, respectively.

Return status shall be one of the following values:
Parameters
- request: DoorLock.ClearYearDayScheduleRequest
Returns MaybePromise
See
MatterSpecification.v13.Cluster § 5.2.10.21
- Defined in packages/node/src/behaviors/door-lock/DoorLockInterface.ts:217

getYearDaySchedule

getYearDaySchedule(request): MaybePromise<DoorLock.GetYearDayScheduleResponse>
Retrieve the specific year day schedule for the specific schedule and user indexes.

† The Schedule ID and User ID are obsolete field names, use YearDayIndex and UserIndex instead, respectively.
Parameters
- request: DoorLock.GetYearDayScheduleRequest
Returns MaybePromise<DoorLock.GetYearDayScheduleResponse>
See
MatterSpecification.v13.Cluster § 5.2.10.19
- Defined in packages/node/src/behaviors/door-lock/DoorLockInterface.ts:206

setYearDaySchedule

setYearDaySchedule(request): MaybePromise
Set a time-specific schedule ID for a specified user.

† The Schedule ID and User ID are obsolete field names, use YearDayIndex and UserIndex instead, respectively.

The associated UserType may be changed to ScheduleRestrictedUser by the lock when a Year Day schedule is set.

Return status shall be one of the following values:
Parameters
- request: DoorLock.SetYearDayScheduleRequest
Returns MaybePromise
See
MatterSpecification.v13.Cluster § 5.2.10.18
- Defined in packages/node/src/behaviors/door-lock/DoorLockInterface.ts:197