Interface GetWeekDayScheduleResponse

Returns the weekly repeating schedule data for the specified schedule index.

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

See

MatterSpecification.v13.Cluster § 5.2.10.16

interface GetWeekDayScheduleResponse {
    daysMask?: TypeFromPartialBitSchema<{
        friday: BitFlag;
        monday: BitFlag;
        saturday: BitFlag;
        sunday: BitFlag;
        thursday: BitFlag;
        tuesday: BitFlag;
        wednesday: BitFlag;
    }>;
    endHour?: number;
    endMinute?: number;
    startHour?: number;
    startMinute?: number;
    status: Status;
    userIndexUserId: number;
    weekDayIndex: number;
}

Hierarchy (view full)

Properties

daysMask? endHour? endMinute? startHour? startMinute? status userIndexUserId weekDayIndex

Properties

OptionaldaysMask

daysMask?: TypeFromPartialBitSchema<{
    friday: BitFlag;
    monday: BitFlag;
    saturday: BitFlag;
    sunday: BitFlag;
    thursday: BitFlag;
    tuesday: BitFlag;
    wednesday: BitFlag;
}>

Type declaration

  • friday: BitFlag

    Schedule is applied on Friday

  • monday: BitFlag

    Schedule is applied on Monday

  • saturday: BitFlag

    Schedule is applied on Saturday

  • sunday: BitFlag

    Schedule is applied on Sunday

  • thursday: BitFlag

    Schedule is applied on Thursday

  • tuesday: BitFlag

    Schedule is applied on Tuesday

  • wednesday: BitFlag

    Schedule is applied on Wednesday

OptionalendHour

endHour?: number

This field shall indicate the ending hour for the Week Day schedule. EndHour shall be equal to or greater than StartHour.

See

MatterSpecification.v13.Cluster § 5.2.10.16.6

OptionalendMinute

endMinute?: number

This field shall indicate the ending minute for the Week Day schedule. If EndHour is equal to StartHour then EndMinute shall be greater than StartMinute.

See

MatterSpecification.v13.Cluster § 5.2.10.16.7

OptionalstartHour

startHour?: number

This field shall indicate the starting hour for the Week Day schedule.

See

MatterSpecification.v13.Cluster § 5.2.10.16.4

OptionalstartMinute

startMinute?: number

This field shall indicate the starting minute for the Week Day schedule.

See

MatterSpecification.v13.Cluster § 5.2.10.16.5

status

status: Status

Status shall be one of the following values:

• SUCCESS if both WeekDayIndex and UserIndex are valid and there is a corresponding schedule entry.

• INVALID_COMMAND if either WeekDayIndex and/or UserIndex values are not within valid range

• NOT_FOUND if no corresponding schedule entry found for WeekDayIndex.

• NOT_FOUND if no corresponding user entry found for UserIndex.

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.16.3

userIndexUserId

userIndexUserId: number

weekDayIndex

weekDayIndex: number

This field shall indicate the index of the Week Day schedule.

See

MatterSpecification.v13.Cluster § 5.2.10.16.1

Settings

Member Visibility

On This Page

Properties