Data Fields | |
| cookie_t | cookie |
| time_t | trigger |
| char * | title |
| char * | message |
| char * | sound |
| char * | icon |
| unsigned | flags |
| char * | alarm_appid |
| time_t | alarm_time |
| struct tm | alarm_tm |
| char * | alarm_tz |
| time_t | snooze_secs |
| time_t | snooze_total |
| size_t | action_cnt |
| alarm_action_t * | action_tab |
| int | response |
| int | recur_count |
| time_t | recur_secs |
| size_t | recurrence_cnt |
| alarm_recur_t * | recurrence_tab |
| size_t | attr_cnt |
| alarm_attr_t ** | attr_tab |
Describes whem alarm should occur, how to handle snoozing and recurrence, and actions to be taken on various trigger points.
Also contains information not used directly by alarmd, like dialog title/message strings and paths to custom icons and sounds.
To ensure forward compatibility the alarm_event_t objects should be allocated using libalarmd functions like alarm_event_create() or alarmd_event_get().
All dynamically allocated members have set/get methods. If these are used, alarm_event_delete and alarm_event_dtor will release all dynamically allocated memory related to alarm_event_t.
Related alarmd functions:
See also:
Unique identifier, issued by alarmd.
Ignored by alarmd_event_add().
Required by alarmd_event_update().
Available after alarmd_event_get().
Access via: alarm_event_get_cookie(), alarm_event_set_cookie()
| time_t alarm_event_t::trigger |
Trigger time, managed by alarmd.
Available after alarmd_event_get().
Access via: alarm_event_get_trigger(), alarm_event_set_trigger()
| char* alarm_event_t::title |
| char* alarm_event_t::message |
| char* alarm_event_t::sound |
Custom sound to play when alarm dialog is shown.
See also:
| char* alarm_event_t::icon |
Custom icon to use when alarm dialog is shown.
See also:
| unsigned alarm_event_t::flags |
Event specific behaviour, bitwise or of alarmeventflags
Name of the application this alarm belongs to.
See also:
| time_t alarm_event_t::alarm_time |
Seconds since epoch, or
-1 = use broken down time spec below.
This specifies the alarm time in absolute terms (seconds since epoch) and thus is not affected by timezone changes.
Note: This means that the interpretation of the alarm time as time-of-day in localtime can change if the timezone is changed. So use this only if you absolutely must have more than one minute accuracy for alarms, or if you do not care about the time-of-day when the alarm should be triggered. Otherwise use alarm_tm instead.
See also:
struct tm alarm_event_t::alarm_tm [read] |
Alarm time broken down to year month day and hour min min sec.
If alarm_tz is left unset, the actual triggering time will be re-evaluated when currently active timezone changes.
Note: Alarm daemon will round up the actual alarm time to the next full minute. If you absolutely need more than one minute accuracy for alarms, use alarm_time instead.
See also:
| char* alarm_event_t::alarm_tz |
Timezone, or NULL for floating local time
Note that alarm timezone is used only when evaluating trigger time from broken down time (alarm_tm) or recurrence time from recurrence masks.
If timezone is left unset the trigger times are re-evaluated on timezone change.
See also:
| time_t alarm_event_t::snooze_secs |
Number of seconds an alarm is postponed on snooze. or
0 = use server default snooze value.
See also:
| time_t alarm_event_t::snooze_total |
How many seconds the event has been snoozed in total. Managed by alarmd. Used to align recurrencies with the original trigger time.
| size_t alarm_event_t::action_cnt |
Dialog response from user, managed by alarmd
Number of recurrences, or
-1 = infinite.
See also:
| time_t alarm_event_t::recur_secs |
Number of seconds between each recurrence, or 0 to use recurrence specifiers below
Number of items in the recurrence_tab.
See also: alarm_event_t::recurrence_cnt
Recurrence specifiers.
See also:
| size_t alarm_event_t::attr_cnt |
Number of items in the attr_tab.
See also: alarm_event_t::attr_cnt
Array of event attributes.
See also:
1.5.6