Interface GetHolidayScheduleResponse

Returns the Holiday Schedule Entry for the specified Holiday ID.

† The Holiday Schedule ID is an obsolete field name, use HolidayIndex instead.

See

MatterSpecification.v13.Cluster § 5.2.10.24

interface GetHolidayScheduleResponse {
    holidayIndex: number;
    localEndTime?: null | number;
    localStartTime?: null | number;
    operatingMode?: null | DoorLock.OperatingMode;
    status: Status;
}

Hierarchy (view full)

Properties

holidayIndex localEndTime? localStartTime? operatingMode? status

Properties

holidayIndex

holidayIndex: number

This field shall indicate the index of the Holiday schedule.

See

MatterSpecification.v13.Cluster § 5.2.10.24.1

OptionallocalEndTime

localEndTime?: null | number

This field shall indicate 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. LocalEndTime shall be greater than LocalStartTime. This shall be null if the schedule is not set for the HolidayIndex provided.

See

MatterSpecification.v13.Cluster § 5.2.10.24.4

OptionallocalStartTime

localStartTime?: null | number

This field shall indicate 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. This shall be null if the schedule is not set for the HolidayIndex provided.

See

MatterSpecification.v13.Cluster § 5.2.10.24.3

OptionaloperatingMode

operatingMode?: null | DoorLock.OperatingMode

This field shall indicate the operating mode to use during this Holiday schedule start/end time. This shall be null if the schedule is not set for the HolidayIndex provided.

See

MatterSpecification.v13.Cluster § 5.2.10.24.5

status

status: Status

Status shall be one of the following values:

• FAILURE if the attribute NumberOfHolidaySchedulesSupported is zero.

• SUCCESS if the HolidayIndex is valid and there is a corresponding schedule entry.

• INVALID_COMMAND if the HolidayIndex is not within valid range

• NOT_FOUND if the HolidayIndex is within the valid range, however, there is not corresponding schedule entry found.

If this field is SUCCESS, the optional fields for this command shall be present. For other (error) status values, only the fields up to the status field shall be present.

See

MatterSpecification.v13.Cluster § 5.2.10.24.2

Settings

Member Visibility

On This Page

Properties