alarm_event_t Struct Reference

Alarm time control + actions to take. More...

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

---

Detailed Description

Alarm time control + actions to take.

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:

• alarmd_event_add()
• alarmd_event_get()
• alarmd_event_del()
• alarmd_event_query()
• alarmd_event_update()
• alarmd_event_add_valist()
• alarmd_event_add_with_dbus_params()

See also:

• alarm_event_create()
• alarm_event_delete()

• alarm_event_get_alarm_appid()
• alarm_event_set_alarm_appid()

• alarm_event_get_title()
• alarm_event_set_title()

• alarm_event_get_message()
• alarm_event_set_message()

• alarm_event_get_icon()
• alarm_event_set_icon()

• alarm_event_get_sound()
• alarm_event_set_sound()

• alarm_event_set_time()
• alarm_event_get_time()

• alarm_event_get_alarm_tz()
• alarm_event_set_alarm_tz()

• alarm_event_add_actions()
• alarm_event_del_actions()
• alarm_event_get_action()
• alarm_event_set_action_dbus_args()
• alarm_event_get_action_dbus_args()
• alarm_event_del_action_dbus_args()

• alarm_event_get_recurrence()
• alarm_event_del_recurrences()
• alarm_event_add_recurrences()

• alarm_event_set_attr_int()
• alarm_event_get_attr_int()
• alarm_event_set_attr_string()
• alarm_event_get_attr_string()
• alarm_event_set_attr_time()
• alarm_event_get_attr_time()
• alarm_event_del_attrs()
• alarm_event_rem_attr()
• alarm_event_get_attr()
• alarm_event_has_attr()
• alarm_event_add_attr()

• alarm_event_is_recurring()
• alarm_event_is_sane()

• alarm_event_ctor()
• alarm_event_dtor()
• alarm_event_delete_cb()
• alarm_event_create_ex()

---

Field Documentation

cookie_t alarm_event_t::cookie

Unique identifier, issued by alarmd.

Ignored by alarmd_event_add().

Required by alarmd_event_update().

Available after alarmd_event_get().

time_t alarm_event_t::trigger

Trigger time, managed by alarmd.

Available after alarmd_event_get().

char* alarm_event_t::title

Title string for the alarm dialog.

See also:

• alarm_event_get_title()
• alarm_event_set_title()

char* alarm_event_t::message

Message string for the alarm dialog.

See also:

• alarm_event_get_message()
• alarm_event_set_message()

char* alarm_event_t::sound

Custom sound to play when alarm dialog is shown.

See also:

• alarm_event_get_sound()
• alarm_event_set_sound()

char* alarm_event_t::icon

Custom icon to use when alarm dialog is shown.

See also:

• alarm_event_get_icon()
• alarm_event_set_icon()

unsigned alarm_event_t::flags

Event specific behaviour, bitwise or of alarmeventflags

char* alarm_event_t::alarm_appid

Name of the application this alarm belongs to.

See also:

• alarm_event_get_alarm_appid()
• alarm_event_set_alarm_appid()

time_t alarm_event_t::alarm_time

Seconds since epoch, or
-1 = use broken down time spec below.

See also:

• alarm_event_get_time()

struct tm alarm_event_t::alarm_tm

Alarm time broken down to year month day and hour min min sec.

See also:

• alarm_event_get_time()
• alarm_event_set_time()

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 or recurrence time from recurrence masks.

If timezone is left unset the trigger times are re-evaluated on timezone change.

See also:

• alarm_event_get_alarm_tz()
• alarm_event_set_alarm_tz()

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:

• alarmd_set_default_snooze()
• alarmd_get_default_snooze()

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

Number of items in the action_tab.

See also:

• alarm_event_add_actions()
• alarm_event_del_actions()

alarm_action_t* alarm_event_t::action_tab

Action descriptors.

See also:

• alarm_event_add_actions()
• alarm_event_del_actions()

int alarm_event_t::response

Dialog response from user, managed by alarmd

int alarm_event_t::recur_count

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

size_t alarm_event_t::recurrence_cnt

Number of items in the recurrence_tab.

See also: alarm_event_t::recurrence_cnt

alarm_recur_t* alarm_event_t::recurrence_tab

Recurrence specifiers.

See also:

• alarm_event_add_recurrences()
• alarm_event_del_recurrences()
• alarm_event_get_recurrence()

size_t alarm_event_t::attr_cnt

Number of items in the attr_tab.

See also: alarm_event_t::attr_cnt

alarm_attr_t** alarm_event_t::attr_tab

Array of event attributes.

See also:

• alarm_event_add_attr()
• alarm_event_get_attr()
• alarm_event_has_attr()
• alarm_event_rem_attr()
• alarm_event_get_attr_int()
• alarm_event_set_attr_int()
• alarm_event_get_attr_string()
• alarm_event_set_attr_string()
• alarm_event_get_attr_time()
• alarm_event_set_attr_time()
• alarm_event_del_attrs()

---

The documentation for this struct was generated from the following file:

• libalarm.h

---