Name

condition days, conditiondays, kPMConditionConditionDays — Conditional on the day of the week.

Synopsis

condition days structure { invert, type, days };
invert : boolean, default, optional
type : string, choice
days : array of day elements, default, length 1..7, unique

Description

Conditional on the day of the week.

days tests the current day of the week is contained in days.

Fields

invert. Invert the condition's conclusion.

Conditions are designed to positively identify specific states. Many events will want a condition to confirm that a specific state is not occuring. To reverse the role of a positive condition, use the invert field.

If a condition is true, and the invert field is set, the condition will invert the true and return false.

If a condition is false, and the invert field is set, the condition will invert the false and return true.

invert is a boolean. If invert is omitted, the default false is used. invert is optional.

type. Type of condition to test.

type is a string. type must be days, kPMConditionType_Days.

days. The day of week is one of the following.

days is an unordered list of week days.

If days contains Monday and Friday, only if the current day of the week is Monday or Friday will the condition resolve to true. If the current day of the week is Tuesday, Wednesday, Thursday, Saturday, or Sunday, the condition will resolve to false.

days is an array of day elements. If days is omitted, the default Saturday,Sunday,Monday,Tuesday,Wednesday,Thursday,Friday is used. days must be between 1 and 7 items long, inclusive. Each item in days must be unique.