Name
trigger daily, triggerdaily, kPMTriggerTriggerDaily — Trigger at a given time on given days of the week.
Synopsis
trigger daily structure { type, seconds from midnight, days, availability, scatter, quiet, drift };
type : string, choice |
seconds from midnight : integer, range 0..86400 |
days : array of day elements, default, length 1..7, unique
|
availability : string, choice, optional |
scatter : integer, default, optional, range 60..43200 |
quiet : boolean, default, optional |
drift : integer, default, optional, range 1..86400 |
Description
Trigger at a given time on given days of the week.
daily trigger will trigger when the time reaches seconds from midnight on the days provided.
Fields
type. Type of trigger being described.
type
is a string. type
must be daily, kPMTriggerType_Daily
.
seconds from midnight. Seconds past midnight to trigger.
The trigger's time is measured in seconds from midnight. Where 0 seconds equals midnight.
Calculate seconds from midnight using the following formula:
seconds from midnight = (hours x (60 x 60)) + (minutes x 60) |
5:30 am = (5 x (60 x 60)) + (30 x 60) = 19800 seconds from midnight |
2:23 pm = (14 x (60 x 60)) + (23 x 60) = 51780 seconds from midnight |
seconds from midnight
is an integer. seconds from midnight
must be between 0
and 86400
, inclusive.
days. Days of the week to trigger.
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.
availability. Should the host be made available for this trigger.
availability
is a string. availability
is optional. availability
must be one of the following three constants:
- wake up,
kPMTriggerAvailability_WakeUp
. - power on,
kPMTriggerAvailability_PowerOn
. - power on or wake up,
kPMTriggerAvailability_PowerOnOrWakeUp
.
scatter. Scatter the date.
scatter
is an integer. If scatter
is omitted, the default 300
is used. scatter
is optional. scatter
must be between 60
and 43200
, inclusive.
quiet. Minimise the notifications.
quiet
is a boolean. If quiet
is omitted, the default false
is used. quiet
is optional.
drift. Acceptable drift.
drift
is an integer. If drift
is omitted, the default 120
is used. drift
is optional. drift
must be between 1
and 86400
, inclusive.