Name

trigger once, triggeronce, kPMTriggerTriggerOnce — Trigger once on a given time and date.

Synopsis

trigger 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

Trigger once on a given time and date.

Fields

type. Type of trigger being described.

type is a string. type must be once, kPMTriggerType_Once.

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