Name
action await once, actionawaitonce, kPMActionActionAwaitOnce — Wait for a specific time and date to occur.
Synopsis
action await once structure { type, date, availability, scatter, quiet, drift };
type : string, choice |
date : date |
availability : string, choice, optional |
scatter : integer, default, optional, range 60..43200 |
quiet : boolean, default, optional |
drift : integer, default, optional, range 1..86400 |
Description
Wait for a specific time and date to occur.
The next action will not be performed until the specified time and date is reached.
Fields
type. Type of action to perform.
type
is a string. type
must be await once, kPMActionType_AwaitOnce
.
date. Date and time to trigger.
date can be any time and date in the past or future. Dates in the past are not useful but not invalid as values.
date
is a date.
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,
kPMActionAvailability_WakeUp
. - power on,
kPMActionAvailability_PowerOn
. - power on or wake up,
kPMActionAvailability_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.