+ + + +

Alarm

+ + + +

You can launch an application at a specific time using alarms. The mechanism involved in launching the application is the App Control API (in mobile and wearable applications).

The AppControl API allows launching an application explicitly, giving its package name, or providing certain criteria that the application must meet. For example, the criteria can include the type of data on which the application must be able to operate. The structure containing the criteria is called an application control.

+ +

The following figure illustrates the rule components and their relations.

+ + + +

Figure: Rule components

Rule components

+ + + + +

The main features of the Alarm API include:

Setting alarms after a specific time +
You can set an alarm to trigger after a specific amount of time.
Setting alarms on specific dates +
You can set an alarm on a specific date.
Setting recurring alarms +
You can set a recurring alarm to trigger at a specific time of the day.
Managing existing alarms +
You can list all scheduled alarms and cancel them.

+ + + +

Trigering events

This feature is ......

+ + + +

Prerequisites

To enable your application to use the alarm functionality:

To use the Alarm API (in mobile and wearable applications), the application has to request permission by adding the following privileges to the tizen-manifest.xml file: + +
```
+<privileges>
+   <privilege>http://tizen.org/privilege/alarm.get</privilege>
+   <privilege>http://tizen.org/privilege/alarm.set</privilege>
+</privileges>
+		 
```
+ +
To use the functions and data types of the Alarm API, include the <app_alarm.h> header file in your application: +
```
+#include <app_alarm.h>
+		 
```
+

+ + + +

Setting an Alarm after Specific Time

+ + + +

+ Note + Since 2.4, the alarm_schedule_after_delay() function does + not support an exact period and delay to minimize the wake-ups of the +device. The system can adjust when the alarm expires. +

+ +

To set an alarm after a specific time:

+ +

Implement the AlarmRegister application:

To identify which application to start when the alarm expires, the Alarm API needs the app_control_h handle.

Obtain the app_control_h handle of a specific app by calling the app_control_set_app_id() function. You can get the AlarmTarget app_id from the tizen-manifest.xml file.

+ + + +

+bool
+init_alarm()
+{
+    int ret;
+    int DELAY = 2;
+    int REMIND = 1;
+    int alarm_id;
+
+    app_control_h app_control = NULL;
+    ret = app_control_create(&app_control);
+    ret = app_control_set_operation(app_control, APP_CONTROL_OPERATION_DEFAULT);
+    ret = app_control_set_app_id(app_control, "org.tizen.alarmslave");
+

To schedule an alarm after a delay, use the alarm_schedule_after_delay() function:

+ +

+void
+service_app_control(app_control_h app_control, void *data)
+{
+    dlog_print(DLOG_INFO, LOG_TAG, "app_control called by Alarm API.");
+}
+

+ +

Implement the AlarmTarget application:

A scheduled alarm calls AlarmTarget's app_control_cb() callback when the alarm expires:

+void
+service_app_control(app_control_h app_control, void *data)
+{
+    dlog_print(DLOG_INFO, LOG_TAG, "app_control called by Alarm API.");
+}
+

+ +

Setting an Alarm on a Specific Date

+ +

To schedule an alarm on a specific date, use the alarm_schedule_at_date() function.

The second parameter defines the time of the first active alarm. It can be defined using the tm struct included in the <time.h> header file. The following table lists the selected tm fields.

+ + + +

Table: tm fields

+ + + + + + + + + + + + + + +

Member	Type	Meaning	Range
`tm_sec`	int	Seconds after the minute	0-61*

+ + + + +