From: mk5004.lee Date: Thu, 26 Sep 2019 08:23:58 +0000 (+0900) Subject: Update doxygen X-Git-Tag: submit/tizen/20200227.043212~3 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=f7fa7ee92842f3726a264ad336894b7ac9628d95;p=platform%2Fcore%2Fapi%2Falarm.git Update doxygen Change-Id: Ia37dcfd5a45322a1fb8b3b2351f0906baacb7a75 Signed-off-by: mk5004.lee --- diff --git a/include/app_alarm.h b/include/app_alarm.h index 90f3a80..1b95f04 100644 --- a/include/app_alarm.h +++ b/include/app_alarm.h @@ -97,10 +97,10 @@ typedef bool (*alarm_registered_alarm_cb)(int alarm_id, void *user_data); * @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, this api does not support exact period and delay for minimizing the wakeups of the device. The system can adjust when the alarm expires. + * Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, this function does not support exact period and delay for minimizing the wakeups of the device. The system can adjust when the alarm expires. * 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 @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif If the appid of @a app_control is not specified, this function 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 @@ -110,10 +110,10 @@ typedef bool (*alarm_registered_alarm_cb)(int alarm_id, void *user_data); * @return @c 0 on success, * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ALARM_ERROR_INVALID_TIME Triggered time is invalid * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_NOT_PERMITTED_APP @a app_control is not permitted * @see alarm_cancel() * @see alarm_cancel_all() @@ -145,10 +145,10 @@ int alarm_schedule_after_delay(app_control_h app_control, int delay, int period, * @return @c 0 on success, * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ALARM_ERROR_INVALID_DATE Triggered date is invalid * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @see alarm_cancel() * @see alarm_cancel_all() * @see alarm_get_scheduled_date() @@ -166,8 +166,8 @@ int alarm_schedule_at_date(app_control_h app_control, struct tm *date, int perio * @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. + * If the appid of @a app_control is not specified, this function is not allowed. In other words, the explicit @a app_control is only allowed. + * The @a app_control only supports UI application with this function. 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. * @@ -177,10 +177,10 @@ int alarm_schedule_at_date(app_control_h app_control, struct tm *date, int perio * @return @c 0 on success, * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ALARM_ERROR_INVALID_TIME Triggered time is invalid * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_NOT_PERMITTED_APP @a app_control is not permitted. @a app_control for UI application is only permitted. * @see alarm_cancel() * @see alarm_cancel_all() @@ -199,8 +199,8 @@ int alarm_schedule_once_after_delay(app_control_h app_control, int delay, int *a * @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. + * If the appid of @a app_control is not specified, this function is not allowed. In other words, the explicit @a app_control is only allowed. + * The @a app_control only supports UI application with this function. 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. * @@ -210,10 +210,10 @@ int alarm_schedule_once_after_delay(app_control_h app_control, int delay, int *a * @return @c 0 on success, * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ALARM_ERROR_INVALID_DATE Triggered date is invalid * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_NOT_PERMITTED_APP @a app_control is not permitted. @a app_control for UI application is only permitted. * @see alarm_cancel() * @see alarm_cancel_all() @@ -235,9 +235,9 @@ int alarm_schedule_once_at_date(app_control_h app_control, struct tm *date, int * @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. + * Since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, The @a app_control only supports UI application with this function. 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 @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif, If the appid of @a app_control is not specified, this function 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 @@ -247,10 +247,10 @@ int alarm_schedule_once_at_date(app_control_h app_control, struct tm *date, int * @return @c 0 on success, * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ALARM_ERROR_INVALID_DATE Triggered date is invalid * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_NOT_PERMITTED_APP @a app_control is not permitted. @a app_control for UI application is only permitted. * @see alarm_cancel() * @see alarm_cancel_all() @@ -268,15 +268,13 @@ int alarm_schedule_with_recurrence_week_flag(app_control_h app_control, struct t * @privilege %http://tizen.org/privilege/alarm.get * @remarks If the given @a alarm_id is not obtained by using the alarm_schedule_with_recurrence_week_flag() function, * an error (error code #ALARM_ERROR_INVALID_PARAMETER) will occur because this alarm is scheduled with no recurrence. - * 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. * @param[in] alarm_id The alarm ID returned when the alarm is scheduled * @param[out] week_flag The recurrence days of the week, @a week_flag may be a combination of days, like #ALARM_WEEK_FLAG_TUESDAY | #ALARM_WEEK_FLAG_FRIDAY * @return @c 0 on success, * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful - * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied + * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @see alarm_schedule_with_recurrence_week_flag() * @see #alarm_week_flag_e */ @@ -292,9 +290,9 @@ int alarm_get_scheduled_recurrence_week_flag(int alarm_id, int *week_flag); * @return @c 0 on success, * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @see alarm_schedule_once_at_date() * @see alarm_schedule_after_delay() * @see alarm_schedule_with_recurrence_week_flag() @@ -304,15 +302,15 @@ int alarm_cancel(int alarm_id); /** - * @brief Cancels all scheduled alarms that are registered by the application that calls this API. + * @brief Cancels all scheduled alarms that are registered by the application that calls this function. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/alarm.set * @return @c 0 on success, * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful - * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied + * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server * @see alarm_schedule_once_at_date() * @see alarm_schedule_after_delay() * @see alarm_schedule_with_recurrence_week_flag() @@ -331,9 +329,9 @@ int alarm_cancel_all(void); * @return @c 0 on success, * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @post This function invokes alarm_registered_alarm_cb() repeatedly for each registered alarm. * @see alarm_registered_alarm_cb() */ @@ -351,9 +349,9 @@ int alarm_foreach_registered_alarm(alarm_registered_alarm_cb callback, void *use * @return @c 0 on success, * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @see alarm_schedule_once_at_date() * @see alarm_schedule_after_delay() * @see alarm_schedule_with_recurrence_week_flag() @@ -373,9 +371,9 @@ int alarm_get_scheduled_date(int alarm_id, struct tm *date); * @return @c 0 on success, * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @see alarm_schedule_once_at_date() * @see alarm_schedule_after_delay() * @see alarm_schedule_with_recurrence_week_flag() @@ -391,7 +389,6 @@ int alarm_get_scheduled_period(int alarm_id, int *period); * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied */ int alarm_get_current_time(struct tm *date); @@ -407,9 +404,9 @@ int alarm_get_current_time(struct tm *date); * @return @c 0 on success, * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ALARM_ERROR_OUT_OF_MEMORY Out of memory - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @see alarm_schedule_once_at_date() * @see alarm_schedule_after_delay() * @see alarm_schedule_with_recurrence_week_flag() @@ -435,9 +432,9 @@ int alarm_get_app_control(int alarm_id, app_control_h *app_control); * @return @c 0 on success, * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ALARM_ERROR_NOT_PERMITTED_APP @a alarm_id is not permitted - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @see alarm_schedule_once_at_date() * @see alarm_schedule_after_delay() * @see alarm_schedule_with_recurrence_week_flag() @@ -455,8 +452,8 @@ int alarm_set_global(int alarm_id, bool global); * @return @c 0 on success, * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful - * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied + * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @see alarm_set_global() */ int alarm_get_global(int alarm_id, bool *global); @@ -479,10 +476,10 @@ int alarm_get_global(int alarm_id, bool *global); * @return @c 0 on success, * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ALARM_ERROR_INVALID_DATE Triggered date is invalid * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @see alarm_cancel() * @see alarm_cancel_all() * @see alarm_get_scheduled_date() @@ -511,11 +508,11 @@ int alarm_schedule_noti_once_at_date(notification_h noti, struct tm *date, int * * @param[out] alarm_id The ID which uniquely identifies the scheduled alarm * @return @c 0 on success, * otherwise a negative error value - * @retval #ALARM_ERROR_NONE Successful - * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #ALARM_ERROR_INVALID_TIME Triggered time is invalid - * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied + * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied + * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #ALARM_ERROR_INVALID_TIME Triggered time is invalid + * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server * @see alarm_cancel() * @see alarm_cancel_all() * @see alarm_get_scheduled_date() @@ -540,11 +537,11 @@ int alarm_schedule_noti_after_delay(notification_h noti, int delay, int period, * @param[out] alarm_id The ID which uniquely identifies the scheduled alarm * @return @c 0 on success, * otherwise a negative error value - * @retval #ALARM_ERROR_NONE Successful - * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #ALARM_ERROR_INVALID_TIME Triggered time is invalid - * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied + * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied + * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #ALARM_ERROR_INVALID_TIME Triggered time is invalid + * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server * @see alarm_cancel() * @see alarm_cancel_all() * @see alarm_get_scheduled_date() @@ -571,10 +568,10 @@ int alarm_schedule_noti_once_after_delay(notification_h noti, int delay, int *al * @return @c 0 on success, * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ALARM_ERROR_INVALID_DATE Triggered date is invalid * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @see alarm_cancel() * @see alarm_cancel_all() * @see alarm_get_scheduled_recurrence_week_flag() @@ -595,9 +592,9 @@ int alarm_schedule_noti_with_recurrence_week_flag(notification_h noti, struct tm * @return @c 0 on success, * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ALARM_ERROR_OUT_OF_MEMORY Out of memory - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @see alarm_schedule_noti_once_at_date() * @see alarm_schedule_noti_after_delay() * @see alarm_schedule_noti_once_after_delay() @@ -621,10 +618,10 @@ int alarm_get_notification(int alarm_id, notification_h *noti); * @return @c 0 on success, * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server * @retval #ALARM_ERROR_OUT_OF_MEMORY Out of memory - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_NOT_PERMITTED_APP App control does not launch an UI application */ int alarm_update_delay(int alarm_id, int delay); @@ -644,12 +641,12 @@ int alarm_update_delay(int alarm_id, int delay); * @return @c 0 on success, * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ALARM_ERROR_INVALID_TIME Triggered time is invalid * @retval #ALARM_ERROR_INVALID_DATE Triggered time is invalid * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server * @retval #ALARM_ERROR_OUT_OF_MEMORY Out of memory - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_NOT_PERMITTED_APP App control does not launch an UI application */ int alarm_update_date(int alarm_id, struct tm *date); @@ -675,10 +672,10 @@ int alarm_update_date(int alarm_id, struct tm *date); * @return @c 0 on success, * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server * @retval #ALARM_ERROR_OUT_OF_MEMORY Out of memory - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied */ int alarm_update_period(int alarm_id, int period); @@ -705,10 +702,10 @@ int alarm_update_period(int alarm_id, int period); * @return @c 0 on success, * otherwise a negative error value * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server * @retval #ALARM_ERROR_OUT_OF_MEMORY Out of memory - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied * @retval #ALARM_ERROR_NOT_PERMITTED_APP App control does not launch an UI application */ int alarm_update_week_flag(int alarm_id, int week_flag); diff --git a/include/app_alarm_extension.h b/include/app_alarm_extension.h index 2ea34e0..13358f7 100644 --- a/include/app_alarm_extension.h +++ b/include/app_alarm_extension.h @@ -40,25 +40,25 @@ extern "C" { * @details The alarm will go off @a delay seconds later. * To cancel the alarm, call alarm_cancel() with @a alarm_id. * @since_tizen 3.0 - * @privlevel public - * @privilege %http://tizen.org/privilege/alarm.set - * @remarks This API only allows service application which has Background Category to set an exact alarm. - * If the application is uninstalled after setting an alarm, the alarm is cancelled automatically. + * @privlevel public + * @privilege %http://tizen.org/privilege/alarm.set + * @remarks This function only allows service application which has Background Category to set an exact alarm. + * 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 r 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 service application which has Background Category with this api. + * If the appid of @a app_control is not specified, this function is not allowed. In other words, the explicit @a app_control is only allowed. + * The @a app_control only supports service application which has Background Category with this function. * * @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) + * @param[in] delay The amount of time before the execution (in seconds) * @param[out] alarm_id The alarm ID that uniquely identifies an alarm - * @return @c 0 on success, - * otherwise a negative error value - * @retval #ALARM_ERROR_NONE Successful - * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #ALARM_ERROR_INVALID_TIME Triggered time is invalid - * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied + * @return @c 0 on success, + * otherwise a negative error value + * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied + * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #ALARM_ERROR_INVALID_TIME Triggered time is invalid + * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server * @see alarm_cancel() * @see alarm_cancel_all() * @see alarm_get_scheduled_date() @@ -70,25 +70,25 @@ int alarm_schedule_service_once_after_delay(app_control_h app_control, int delay * @details The @a date describes the time of the first occurrence. * To cancel the alarm, call alarm_cancel() with @a alarm_id. * @since_tizen 3.0 - * @privlevel public - * @privilege %http://tizen.org/privilege/alarm.set - * @remarks This API only allows service application which has Background Category to set an exact alarm. - * If application is uninstalled after setting an alarm, the alarm is cancelled automatically. + * @privlevel public + * @privilege %http://tizen.org/privilege/alarm.set + * @remarks This function only allows service application which has Background Category to set an exact alarm. + * 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 service application which has Background Category with this api. + * If the appid of @a app_control is not specified, this function is not allowed. In other words, the explicit @a app_control is only allowed. + * The @a app_control only supports service application which has Background Category with this function. * - * @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 - * @param[out] alarm_id The alarm ID that uniquely identifies an alarm - * @return @c 0 on success, - * otherwise a negative error value - * @retval #ALARM_ERROR_NONE Successful - * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #ALARM_ERROR_INVALID_DATE Triggered date is invalid - * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied + * @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 + * @param[out] alarm_id The alarm ID that uniquely identifies an alarm + * @return @c 0 on success, + * otherwise a negative error value + * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied + * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #ALARM_ERROR_INVALID_DATE Triggered date is invalid + * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server * @see alarm_cancel() * @see alarm_cancel_all() * @see alarm_get_scheduled_date() @@ -96,47 +96,44 @@ int alarm_schedule_service_once_after_delay(app_control_h app_control, int delay int alarm_schedule_service_once_at_date(app_control_h app_control, struct tm *date, int *alarm_id); /** - * @brief Changes the system time which tranferred by other module + * @brief Changes the system time which tranferred by other module. * @since_tizen 3.0 - * @privlevel platform - * @privilege %http://tizen.org/privilege/systemsettings.admin - * - * @param[in] new_time epoch time to be set - * @return @c 0 on success, - * otherwise a negative error value - * @retval #ALARM_ERROR_NONE Successful - * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server + * @privlevel platform + * @privilege %http://tizen.org/privilege/systemsettings.admin + * @param[in] new_time epoch time to be set + * @return @c 0 on success, + * otherwise a negative error value + * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server */ int alarm_set_systime(int new_time); /** - * @brief Changes the system time and compensates the time using propagation delay + * @brief Changes the system time and compensates the time using propagation delay. * @since_tizen 3.0 - * @privlevel platform - * @privilege %http://tizen.org/privilege/systemsettings.admin - * - * @param[in] new_time system time to be set (seconds, nanoseconds) - * @param[in] req_time time to request to change the system time (seconds, nanoseconds) - * @return @c 0 on success, - * otherwise a negative error value - * @retval #ALARM_ERROR_NONE Successful - * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server + * @privlevel platform + * @privilege %http://tizen.org/privilege/systemsettings.admin + * @param[in] new_time system time to be set (seconds, nanoseconds) + * @param[in] req_time time to request to change the system time (seconds, nanoseconds) + * @return @c 0 on success, + * otherwise a negative error value + * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server */ int alarm_set_systime_with_propagation_delay(struct timespec new_time, struct timespec req_time); /** - * @brief Changes the timezone which tranferred by other module + * @brief Changes the timezone which tranferred by other module. * @since_tizen 3.0 - * @privlevel platform - * @privilege %http://tizen.org/privilege/systemsettings.admin - * - * @param[in] tzpath_str the path to timezone definition file - * @return @c 0 on success, - * otherwise a negative error value - * @retval #ALARM_ERROR_NONE Successful - * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server + * @privlevel platform + * @privilege %http://tizen.org/privilege/systemsettings.admin + * @param[in] tzpath_str the path to timezone definition file + * @return @c 0 on success, + * otherwise a negative error value + * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server */ int alarm_set_timezone(char *tzpath_str); diff --git a/include/app_alarm_internal.h b/include/app_alarm_internal.h index 9a9b5f7..44e45ec 100644 --- a/include/app_alarm_internal.h +++ b/include/app_alarm_internal.h @@ -43,25 +43,24 @@ extern "C" { * @privlevel public * @privilege %http://tizen.org/privilege/alarm.set * @privilege %http://tizen.org/privilege/appmanager.launch - * @remarks This API only for in-house applications. - * This API only allows service application which has Background Category to set an exact alarm. + * @remarks This function only for in-house applications. + * This function only allows service application which has Background Category to set an exact alarm. * 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 service application which has Background Category with this api. - * + * If the appid of @a app_control is not specified, this function is not allowed. In other words, the explicit @a app_control is only allowed. + * The @a app_control only supports service application which has Background Category with this function. * @param[in] app_control The destination app_control to perform a specific task when the alarm is triggered * @param[in] date The first active alarm time * @param[in] period The amount of time between subsequent alarms (in seconds). * @param[out] alarm_id The alarm ID that uniquely identifies an alarm * @return @c 0 on success, * otherwise a negative error value - * @retval #ALARM_ERROR_NONE Successful - * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter - * @retval #ALARM_ERROR_INVALID_TIME Triggered time is invalid - * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server - * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied + * @retval #ALARM_ERROR_NONE Successful + * @retval #ALARM_ERROR_PERMISSION_DENIED Permission denied + * @retval #ALARM_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #ALARM_ERROR_INVALID_TIME Triggered time is invalid + * @retval #ALARM_ERROR_CONNECTION_FAIL Failed to connect to an alarm server * @see alarm_cancel() * @see alarm_cancel_all() * @see alarm_get_scheduled_date()