doc/appfw_alarm_doc.h

   1 /*
   2  * Copyright (c) 2011 - 2016 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17
  18 #ifndef __TIZEN_APPFW_ALARM_DOC_H__
  19 #define __TIZEN_APPFW_ALARM_DOC_H__
  20
  21  /**
  22  * @ingroup CAPI_APPLICATION_MODULE
  23  * @defgroup CAPI_ALARM_MODULE Alarm
  24  * @brief The @ref CAPI_ALARM_MODULE API allows setting an "alarm clock" for the delivery of a notification at some point in the future.
  25  *
  26  * @section CAPI_ALARM_MODULE_HEADER Required Header
  27  *   \#include <app_alarm.h>
  28  *
  29  * @section CAPI_ALARM_MODULE_OVERVIEW Overview
  30  * Mobile devices typically give constant access to information from various sources. Some of this information is best delivered
  31  * through alarms - the most obvious case is a calendar scheduling application which lets you know when a meeting is about to start.
  32  * Alarms are certainly better than actively waiting in a loop.  They are also better than putting an interface to sleep because they do not
  33  * block your main UI thread.  Use of alarms helps build smooth user experiences and implements unattended data synchronization tasks.
  34  * If an application is installed after setting the alarm, your alarm is cancelled automatically.\n
  35  * When the alarm is expired, Alarm Manager will turn on LCD to prohibit background jobs.
  36  * If you want to use alarm API without turning on LCD, you can use alarm_schedule_after_delay().
  37  *
  38  * There are 3 ways to set an alarm.
  39  * <table>
  40  * <tr>
  41  * <th>FUNCTION</th>
  42  * <th>DESCRIPTION</th>
  43  * </tr>
  44  * <tr>
  45  * <td>alarm_schedule_once_after_delay()</td>
  46  * <td>Sets an alarm to be triggered at specific time once</td>
  47  * </tr>
  48  * <tr>
  49  * <td>alarm_schedule_once_at_date()</td>
  50  * <td>Sets an alarm to be triggered after specific delay once</td>
  51  * </tr>
  52  * <tr>
  53  * <td>alarm_schedule_with_recurrence_week_flag()</td>
  54  * <td>Sets an alarm to be triggered at specific time with recurrent days of the week(can repeat on days of the week)</td>
  55  * </tr>
  56  * <tr>
  57  * <td>alarm_schedule_after_delay()</td>
  58  * <td>Sets an alarm to be triggered after specific time(Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, this api does not support exact period and delay for minimizing the wakeups of the device. The system can adjust when the alarm expires.)</td>
  59  * </tr>
  60  * </table>
  61  * \n
  62  *
  63  */
  64
  65 #endif /* __TIZEN_APPFW_ALARM_DOC_H__ */
  66