Name

condition time range, conditiontimerange, kPMConditionConditionTimeRange — Conditional on the time now falling within a specific period.

Synopsis

condition time range structure { invert, type, not before, not after };
invert : boolean, default, optional
type : string, choice
not before : integer, range 0..86400
not after : integer, range 0..86400

Description

Conditional on the time now falling within a specific period.

time range tests if the time now, falls between two provided times.

The time range may cover two periods; spans between the two times within one day and spans between two times over two days. The period is determined by the order of the times.

9am - 5pm = one day
5pm - 9am = two 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 time range, kPMConditionType_TimeRange.

not before. The time is not before this time.

not before is an integer. not before must be between 0 and 86400, inclusive.

not after. The time is not after this time.

not after is an integer. not after must be between 0 and 86400, inclusive.