Documentation/Maemo 5 Developer Guide/Using Generic Platform Components/Alarm Framework

#include <alarmd/libalarm.h>
#define APPID "example-apps"
 
static cookie_t add_two_button_alarm(void)
{
  cookie_t cookie = 0;
  alarm_event_t *eve = 0;
  alarm_action_t *act = 0;
 
  /* Create alarm event structure, set application
   * identifier and dialog message */
  eve = alarm_event_create();
  alarm_event_set_alarm_appid(eve, APPID);
  alarm_event_set_message(eve, "Example Message");
 
  /* Use absolute time triggering, show dialog
   * ten seconds from now */
  eve->alarm_time = time(0) + 10;
 
  /* Add stop button action */
  act = alarm_event_add_actions(eve, 1);
  alarm_action_set_label(act, "Stop");
  act->flags |= ALARM_ACTION_WHEN_RESPONDED;
  act->flags |= ALARM_ACTION_TYPE_NOP;
 
  /* Add snooze button action */
  act = alarm_event_add_actions(eve, 1);
  alarm_action_set_label(act, "Snooze");
  act->flags |= ALARM_ACTION_WHEN_RESPONDED;
  act->flags |= ALARM_ACTION_TYPE_SNOOZE;
 
  /* Send the alarm to alarmd */
  cookie = alarmd_event_add(eve);
 
  /* Free all dynamic memory associated with the
   * alarm event */
  alarm_event_delete(eve);
 
  return cookie;
}

static void show_alarm_details(cookie_t cookie)
{
  alarm_event_t *eve = 0;
  alarm_action_t *act = 0;
  time_t tmo = time(0);
 
  if( (eve = alarmd_event_get(cookie)) == 0 )
  {
    printf("unable to get details for cookie=%ld\n", (long)cookie);
    goto cleanup;
  }
 
  printf("cookie %ld:\n", (long)cookie);
 
  tmo -= eve->trigger;
  printf("appid = %s\n", alarm_event_get_alarm_appid(eve));
  printf("trigger = T%+ld, %s", (long)tmo, ctime(&eve->trigger));
  printf("message = %s\n", alarm_event_get_message(eve));
 
  for( int i = 0; (act = alarm_event_get_action(eve, i)) != 0; ++i )
  {
    printf("action%d.label = %s\n", i, alarm_action_get_label(act));
  }
 
  cleanup:
 
  /* Free all dynamic memory associated with the
   * alarm event */
  alarm_event_delete(eve);
}

static void delete_alarm(cookie_t cookie)
{
  if( alarmd_event_del(cookie) == -1 )
  {
    printf("unable to delete cookie=%ld\n", (long)cookie);
  }
  else
  {
    printf("deleted cookie=%ld\n", (long)cookie);
  }
}

static void list_alarms()
{
  cookie_t *list = 0;
  cookie_t cookie = 0;
  alarm_event_t *eve = 0;
 
  if( (list = alarmd_event_query(0,0, 0,0, APPID)) == 0 )
  {
    printf("query failed\n");
    goto cleanup;
  }
 
  for( int i = 0; (cookie = list[i]) != 0; ++i )
  {
    alarm_event_delete(eve);
 
    if( (eve = alarmd_event_get(cookie)) == 0 )
    {
      printf("unable to get details for cookie=%ld\n", (long)cookie);
      continue;
    }
 
    printf("cookie: %ld, %s", cookie, ctime(&eve->trigger));
  }
 
  cleanup:
    free(list);
    alarm_event_delete(eve);
}

static cookie_t update_alarm(cookie_t cookie)
{
  cookie_t result = -1;
  alarm_event_t *eve = 0;
 
  if( (eve = alarmd_event_get(cookie)) == 0 )
  {
    printf("unable to get details for cookie=%ld\n", (long)cookie);
    goto cleanup;
  }
 
  alarm_event_set_message(eve, "Updated Message");
  eve->alarm_time = time(0) + 20;
 
  result = alarmd_event_update(eve);
 
  cleanup:
    alarm_event_delete(eve);
    return result;
}

  alarm_event_t eve;
  alarm_event_t *eve = calloc(1, sizeof *eve);

  eve = alarm_event_create();
  self->alarm_appid = (char *)"myapp";

  eve = alarm_event_create();
  self->alarm_appid = strdup("myapp");

#define TEXTDOMAIN "mydomain"
#define MESSAGE_KEY "translatable message text"
#define STOP_BUTTON_KEY "translatable stop text"
#define SNOOZE_BUTTON_KEY "translatable snooze text"
 
static cookie_t add_two_button_alarm_with_textdomain(void)
{
  alarm_event_t *eve = 0;
  alarm_action_t *act = 0;
  cookie_t cookie = 0;
 
  /* Create alarm event structure, set application
   * identifier and dialog message */
  eve = alarm_event_create();
  alarm_event_set_alarm_appid(eve, APPID);
  alarm_event_set_message(eve, MESSAGE_KEY);
 
  /* Set the textdomain to be used while making
   * translation lookups */
 
  alarm_event_set_attr_string(eve, "textdomain", TEXTDOMAIN);
 
  /* Use absolute time triggering, show dialog
   * ten seconds from now */
  eve->alarm_time = time(0) + 10;
 
  /* Add stop button action */
  act = alarm_event_add_actions(eve, 1);
  alarm_action_set_label(act, STOP_BUTTON_KEY);
  act->flags |= ALARM_ACTION_WHEN_RESPONDED;
  act->flags |= ALARM_ACTION_TYPE_NOP;
 
  /* Add snooze button action */
  act = alarm_event_add_actions(eve, 1);
  alarm_action_set_label(act, SNOOZE_BUTTON_KEY);
  act->flags |= ALARM_ACTION_WHEN_RESPONDED;
  act->flags |= ALARM_ACTION_TYPE_SNOOZE;
 
  /* Send the alarm to alarmd */
  cookie = alarmd_event_add(eve);
 
  /* Free all dynamic memory associated with the
   * alarm event */
  alarm_event_delete(eve);
 
  return cookie;
}

int testSetAlarm()
{
  alarm_event_t *newEvent = 0;
  alarm_action_t *act = 0;
 
  /* AlarmD will return a unique "alarm cookie" if successful; you can use this
   * later to identify and manipulate your alarm, or just ignore it. */
  cookie_t resultCookie;
 
  /* Create a new alarm event object. */
  newEvent = alarm_event_create();
 
  /* Set the application ID. */
  alarm_event_set_alarm_appid(newEvent, "MYAPP");
 
  /* Set the title of the alarm. */
  alarm_event_set_title(newEvent, "testAlarm");
 
  /* If you are dealing with re-curring alarms, there are two ways to do this.
   * The "old way" is to simply set how many times you want to recur, and how
   * many seconds between each. I use this way because it's easier for simple
   * recurrence.
   *
   * "Old" way
   * Set the # of seconds between recurrences. Let's say once an hour for
   * example (60 seconds * 60 minutes = 1 hour): */
  newEvent->recur_secs = 60 * 60;
 
  /* How many times should the event occur? If you set this to -1, it will
   * reoccur infinitely. */
  newEvent->recur_count = -1;
 
  /* When will the event occur for the very first time? After this point it
   * will occur every 3600 seconds...
   * For this demo I will make the first alarm happen 1 hour from the current
   * time. This "time" is in standard UNIX time format, so you need # of
   * seconds since Unix Epoch. In C you do this by calling time(NULL); I then
   * add 3600 to make the time 1 hour ahead of current time. */
  newEvent->alarm_time = (time_t) time(NULL) + 3600;
 
  /* You can also use the "new way" of setting up timing on events, which
   * allows you to use a time structure instead of just a fixed # of seconds.
   * So you can make an alarm happen every Monday, for example, or every Monday
   * and Thursday. See the information earlier in the Wiki entry for details on
   * this. */
 
  /* Now that our event is setup, we need to add an action to it so that the
   * alarm actually "does" something. */
 
  /* Add 1 action to our alarm event, and assign it to the "act" variable. */
  act = alarm_event_add_actions(newEvent, 1);
 
  /* Now setup that action to do something. To do this we have to set the
   * action "flags". You can find all of them with explanations in the
   * documentation, here: http://maemo.org/api_refs/5.0/5.0-final/libalarm/libalarm_8h.html#cc8e6f439d134448001132132476683c910f7626ec85a4170659b53fa2f0abc7
   * Setup this action to be an "Execute command" one. */
  act->flags = ALARM_ACTION_WHEN_TRIGGERED | ALARM_ACTION_TYPE_EXEC; 
 
  /* Now all you have to do is tell the action which command you want to
   * "execute". */
  alarm_action_set_exec_command(act, "/usr/sbin/myAwesomeCommand.sh");
 
  /* Finally with everything setup, try to add your event to the alarm queue. */
  resultCookie = alarmd_event_add(newEvent);
}

int testSetAlarm()
{  alarm_event_t *newEvent = 0;
  alarm_action_t *act = 0;
 
  /* AlarmD will return a unique "alarm cookie" if successful; you can use this
   * later to identify and manipulate your alarm, or just ignore it. */
  cookie_t resultCookie;
 
  /* Create a new alarm event object. */
  newEvent = alarm_event_create();
 
  /* Set the application ID. */
  alarm_event_set_alarm_appid(newEvent, "MYAPP");
 
  /* Set the title of the alarm. */
  alarm_event_set_title(newEvent, "testAlarm");
 
  /* If you are dealing with re-curring alarms, there are two ways to do this.
   * The "old way" is to simply set how many times you want to recur, and how
   * many seconds between each. I use this way because it's easier for simple
   * recurrence.
   *
   * "Old" way
   * Set the # of seconds between recurrences. Let's say once an hour for
   * example (60 seconds * 60 minutes = 1 hour): */
  newEvent->recur_secs = 60 * 60;
 
  /* How many times should the event occur? If you set this to -1, it will
   * reoccur infinitely. */
  newEvent->recur_count = -1;
 
  /* When will the event occur for the very first time? After this point it
   * will occur every 3600 seconds...
   * For this demo I will make the first alarm happen 1 hour from the current
   * time. This "time" is in standard UNIX time format, so you need # of
   * seconds since Unix Epoch. In C you do this by calling time(NULL); I then
   * add 3600 to make the time 1 hour ahead of current time. */
  newEvent->alarm_time = (time_t) time(NULL) + 3600;
 
  /* Setup the event to boot the device if it's not powered on. */
  newEvent->flags = ALARM_EVENT_BOOT;
 
  /* Now that our event is setup, we need to add an action to it so that the
   * alarm actually "does" something. */
 
  /* Add 1 action to our alarm event, and assign it to the "act" variable. */
  act = alarm_event_add_actions(newEvent, 1);
 
  /* Now setup that action to do something. To do this we have to set the
   * action "flags". You can find all of them with explanations in the
   * documentation, here: http://maemo.org/api_refs/5.0/5.0-final/libalarm/libalarm_8h.html#cc8e6f439d134448001132132476683c910f7626ec85a4170659b53fa2f0abc7
   * Setup this action to be an "DBus command" one; also set it up to use D-Bus
   * auto-activation. */
  act->flags = ALARM_ACTION_WHEN_TRIGGERED | ALARM_ACTION_DBUS_USE_ACTIVATION | ALARM_ACTION_TYPE_DBUS;
 
  /* Setup the DBus params for this action. */
  alarm_action_set_dbus_interface(act, "org.maemo.testApp");
  alarm_action_set_dbus_service(act, "org.maemo.testApp");
  alarm_action_set_dbus_path(act, "/org/maemo/testApp");
  alarm_action_set_dbus_name(act, "triggerAlarm");
 
  /* Finally with everything setup, try to add your event to the alarm queue. */
  resultCookie = alarmd_event_add(newEvent);
}