Add doxygen comments for appmanager.launch privilege 15/212315/2
authorInkyun Kil <inkyun.kil@samsung.com>
Tue, 20 Aug 2019 07:55:59 +0000 (16:55 +0900)
committerInkyun Kil <inkyun.kil@samsung.com>
Wed, 21 Aug 2019 08:45:56 +0000 (17:45 +0900)
Change-Id: Iab3addfffd8bbfe224e3eb01935ccbf6e8f3d669
Signed-off-by: Inkyun Kil <inkyun.kil@samsung.com>
include/app_alarm.h

index 3d59ca2..90f3a80 100644 (file)
@@ -93,6 +93,7 @@ typedef bool (*alarm_registered_alarm_cb)(int alarm_id, void *user_data);
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/alarm.set
+ * @privilege %http://tizen.org/privilege/appmanager.launch
  * @remarks If the application is uninstalled after setting an alarm, the alarm is cancelled automatically.
  *          If the operation of @a app_control is not specified, #APP_CONTROL_OPERATION_DEFAULT is used for the launch request.
  *          If the operation of @a app_control is #APP_CONTROL_OPERATION_DEFAULT, the package information is mandatory to explicitly launch the application.
@@ -100,6 +101,7 @@ typedef bool (*alarm_registered_alarm_cb)(int alarm_id, void *user_data);
  *          If you want to trigger an alarm exactly, see @see alarm_schedule_once_after_delay()
  *          Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif If @a app_control is specified with service-application, the application is only allowed to run on which has Background Category.
  *          Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif If the appid of @a app_control is not specified, this api is not allowed. In other words, the explicit @a app_control is only allowed.
+ *          Since 4.0, %http://tizen.org/privilege/appmanager.launch privilege is additionally required.
  *
  * @param[in] app_control The destination app_control to perform a specific task when the alarm is triggered
  * @param[in] delay The amount of time before the first execution (in seconds). Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, Although this is inexact, the alarm will not fire before this time
@@ -160,12 +162,14 @@ int alarm_schedule_at_date(app_control_h app_control, struct tm *date, int perio
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/alarm.set
+ * @privilege %http://tizen.org/privilege/appmanager.launch
  * @remarks If the application is uninstalled after setting an alarm, the alarm is cancelled automatically.
  *          If the operation of @a app_control is not specified, #APP_CONTROL_OPERATION_DEFAULT is used for the launch request.
  *          If the operation of @a app_control is #APP_CONTROL_OPERATION_DEFAULT, the package information is mandatory to explicitly launch the application.
  *          If the appid of @a app_control is not specified, this api is not allowed. In other words, the explicit @a app_control is only allowed.
  *          The @a app_control only supports UI application with this api. If @a app_control is not UI application, #ALARM_ERROR_NOT_PERMITTED_APP returned.
  *          When the alarm is expired, Alarm Manager will turn on LCD to prohibit background jobs.
+ *          Since 4.0, %http://tizen.org/privilege/appmanager.launch privilege is additionally required.
  *
  * @param[in] app_control The destination app_control to perform a specific task when the alarm is triggered
  * @param[in] delay The amount of time before the execution (in seconds)
@@ -191,12 +195,14 @@ int alarm_schedule_once_after_delay(app_control_h app_control, int delay, int *a
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/alarm.set
+ * @privilege %http://tizen.org/privilege/appmanager.launch
  * @remarks If application is uninstalled after setting an alarm, the alarm is cancelled automatically.
  *          If the operation of @a app_control is not specified, #APP_CONTROL_OPERATION_DEFAULT is used for the launch request.
  *          If the operation of @a app_control is #APP_CONTROL_OPERATION_DEFAULT, the package information is mandatory to explicitly launch the application.
  *          If the appid of @a app_control is not specified, this api is not allowed. In other words, the explicit @a app_control is only allowed.
  *          The @a app_control only supports UI application with this api. If @a app_control is not UI application, #ALARM_ERROR_NOT_PERMITTED_APP returned.
  *          When the alarm is expired, Alarm Manager will turn on LCD to prohibit background jobs.
+ *          Since 4.0, %http://tizen.org/privilege/appmanager.launch privilege is additionally required.
  *
  * @param[in] app_control The destination app_control to perform specific work when the alarm is triggered
  * @param[in] date The first active alarm time
@@ -225,12 +231,14 @@ int alarm_schedule_once_at_date(app_control_h app_control, struct tm *date, int
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  * @privlevel public
  * @privilege %http://tizen.org/privilege/alarm.set
+ * @privilege %http://tizen.org/privilege/appmanager.launch
  * @remarks If the application is uninstalled after setting an alarm, the alarm is cancelled automatically.
  *          If the operation of @a app_control is not specified, #APP_CONTROL_OPERATION_DEFAULT is used for the launch request.
  *          If the operation of @a app_control is #APP_CONTROL_OPERATION_DEFAULT, the package information is mandatory to explicitly launch the application.
  *          Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, The @a app_control only supports UI application with this api. If @a app_control is not UI application, #ALARM_ERROR_NOT_PERMITTED_APP returned.
  *          When the alarm is expired, Alarm Manager will turn on LCD to prohibit background jobs.
  *          Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, If the appid of @a app_control is not specified, this api is not allowed. In other words, the explicit @a app_control is only allowed.
+ *          Since 4.0, %http://tizen.org/privilege/appmanager.launch privilege is additionally required.
  *
  * @param[in] app_control The destination app_control to perform specific work when the alarm is triggered
  * @param[in] date The first active alarm time