diff options
Diffstat (limited to 'include/badge.h')
| -rwxr-xr-x | include/badge.h | 141 |
1 files changed, 80 insertions, 61 deletions
diff --git a/include/badge.h b/include/badge.h index 7137d1f..b7b7f65 100755 --- a/include/badge.h +++ b/include/badge.h @@ -40,18 +40,18 @@ extern "C" { /** * @deprecated Deprecated since @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif Use badge_add instead. * @brief Creates a badge for the application itself. + * @details Creates new badge to display. * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif * @privlevel public * @privilege %http://tizen.org/privilege/notification - * @details Creates new badge to display. * @param[in] writable_app_id The id of application which is authorized to change the badge * @return #BADGE_ERROR_NONE if success, other value if failure - * @retval BADGE_ERROR_NONE Success - * @retval BADGE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method - * @retval BADGE_ERROR_IO_ERROR Error from I/O - * @retval BADGE_ERROR_SERVICE_NOT_READY Service is not ready - * @retval BADGE_ERROR_NOT_SUPPORTED Not supported + * @retval #BADGE_ERROR_NONE Success + * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method + * @retval #BADGE_ERROR_IO_ERROR Error from I/O + * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready + * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported * @see #badge_error_e * @par Sample code: * @code @@ -72,18 +72,21 @@ int badge_new(const char *writable_app_id) TIZEN_DEPRECATED_API; /** * @brief Creates a badge for the application specified by the badge_app_id. - * @remarks Creating and updating a badge of the other application is allowed only when both applications are signed with the same certificate. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/notification + * @remarks Creating and updating a badge of the other application is allowed only when both applications are signed with the same certificate. * @param[in] badge_app_id The id of the application for which the badge will be created. This parameter can be null when creating a badge for itself. * @return #BADGE_ERROR_NONE If success, other value if failure * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method * @retval #BADGE_ERROR_IO_ERROR Error from I/O + * @retval #BADGE_ERROR_FROM_DB Error from DB + * @retval #BADGE_ERROR_ALREADY_EXIST Already exist * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready * @retval #BADGE_ERROR_INVALID_PACKAGE The caller application is not signed with the certificate of the badge_app_id - * @retval BADGE_ERROR_NOT_SUPPORTED Not supported + * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported * @see #badge_error_e * @par Sample code: * @code @@ -108,12 +111,15 @@ int badge_add(const char *badge_app_id); * @privilege %http://tizen.org/privilege/notification * @param[in] app_id The name of the designated application * @return #BADGE_ERROR_NONE if success, other value if failure - * @retval BADGE_ERROR_NONE Success - * @retval BADGE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method - * @retval BADGE_ERROR_IO_ERROR Error from I/O - * @retval BADGE_ERROR_SERVICE_NOT_READY Service is not ready - * @retval BADGE_ERROR_NOT_SUPPORTED Not supported + * @retval #BADGE_ERROR_NONE Success + * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method + * @retval #BADGE_ERROR_IO_ERROR Error from I/O + * @retval #BADGE_ERROR_FROM_DB Error from DB + * @retval #BADGE_ERROR_NOT_EXIST Not exist + * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready + * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported * @see #badge_error_e * @par Sample code: * @code @@ -139,12 +145,15 @@ int badge_remove(const char *app_id); * @param[in] app_id The name of the designated application * @param[in] count The count of the badge * @return #BADGE_ERROR_NONE if success, other value if failure - * @retval BADGE_ERROR_NONE Success - * @retval BADGE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method - * @retval BADGE_ERROR_IO_ERROR Error from I/O - * @retval BADGE_ERROR_SERVICE_NOT_READY Service is not ready - * @retval BADGE_ERROR_NOT_SUPPORTED Not supported + * @retval #BADGE_ERROR_NONE Success + * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method + * @retval #BADGE_ERROR_IO_ERROR Error from I/O + * @retval #BADGE_ERROR_FROM_DB Error from DB + * @retval #BADGE_ERROR_NOT_EXIST Not exist + * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready + * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported * @see #badge_error_e * @see badge_new() * @par Sample code: @@ -171,13 +180,15 @@ int badge_set_count(const char *app_id, unsigned int count); * @param[in] app_id The name of the designated application * @param[out] count The count of the badge * @return #BADGE_ERROR_NONE if success, other value if failure - * @retval BADGE_ERROR_NONE Success - * @retval BADGE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method - * @retval BADGE_ERROR_FROM_DB Error from DB - * @retval BADGE_ERROR_ALREADY_EXIST Already exist - * @retval BADGE_ERROR_OUT_OF_MEMORY Out of memory - * @retval BADGE_ERROR_NOT_SUPPORTED Not supported + * @retval #BADGE_ERROR_NONE Success + * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method + * @retval #BADGE_ERROR_IO_ERROR Error from I/O + * @retval #BADGE_ERROR_FROM_DB Error from DB + * @retval #BADGE_ERROR_NOT_EXIST Not exist + * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready + * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported * @see #badge_error_e * @see badge_new() * @see badge_set_count() @@ -206,12 +217,15 @@ int badge_get_count(const char *app_id, unsigned int *count); * @param[in] app_id The name of the designated application * @param[in] is_display The display option (1 = display, 0 = not display) * @return #BADGE_ERROR_NONE if success, other value if failure - * @retval BADGE_ERROR_NONE Success - * @retval BADGE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method - * @retval BADGE_ERROR_IO_ERROR Error from I/O - * @retval BADGE_ERROR_SERVICE_NOT_READY Service is not ready - * @retval BADGE_ERROR_NOT_SUPPORTED Not supported + * @retval #BADGE_ERROR_NONE Success + * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method + * @retval #BADGE_ERROR_IO_ERROR Error from I/O + * @retval #BADGE_ERROR_FROM_DB Error from DB + * @retval #BADGE_ERROR_NOT_EXIST Not exist + * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready + * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported * @see #badge_error_e * @see badge_new() * @par Sample code: @@ -238,14 +252,15 @@ int badge_set_display(const char *app_id, unsigned int is_display); * @param[in] app_id The name of the designated application * @param[out] is_display The display option (1 = display, 0 = not display) * @return #BADGE_ERROR_NONE if success, other value if failure - * @retval BADGE_ERROR_NONE Success - * @retval BADGE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method - * @retval BADGE_ERROR_FROM_DB Error from DB - * @retval BADGE_ERROR_NOT_EXIST Not exist - * @retval BADGE_ERROR_SERVICE_NOT_READY Service is not ready - * @retval BADGE_ERROR_OUT_OF_MEMORY Out of memory - * @retval BADGE_ERROR_NOT_SUPPORTED Not supported + * @retval #BADGE_ERROR_NONE Success + * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method + * @retval #BADGE_ERROR_IO_ERROR Error from I/O + * @retval #BADGE_ERROR_FROM_DB Error from DB + * @retval #BADGE_ERROR_NOT_EXIST Not exist + * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready + * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported * @see #badge_error_e * @see badge_new() * @see badge_set_count() @@ -286,13 +301,15 @@ typedef bool (*badge_foreach_cb)(const char *app_id, unsigned int count, void *u * @param[in] callback The callback function * @param[in] user_data The user data to be passed to the callback function * @return #BADGE_ERROR_NONE if success, other value if failure - * @retval BADGE_ERROR_NONE Success - * @retval BADGE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method - * @retval BADGE_ERROR_FROM_DB Error form DB - * @retval BADGE_ERROR_OUT_OF_MEMORY Out of memory - * @retval BADGE_ERROR_NOT_EXIST Not exist - * @retval BADGE_ERROR_NOT_SUPPORTED Not supported + * @retval #BADGE_ERROR_NONE Success + * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method + * @retval #BADGE_ERROR_IO_ERROR Error from I/O + * @retval #BADGE_ERROR_FROM_DB Error form DB + * @retval #BADGE_ERROR_NOT_EXIST Not exist + * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready + * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported * @see #badge_error_e * @see badge_foreach_cb() */ @@ -324,19 +341,21 @@ typedef void (*badge_change_cb)(unsigned int action, const char *app_id, unsigned int count, void *user_data); /** * @brief Registers a callback function to receive badge change event. - * @remarks Should be used in the homescreen.\n - * Prospective Clients : Homescreen. * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif * @privlevel public * @privilege %http://tizen.org/privilege/notification + * @remarks Should be used in the homescreen.\n + * Prospective Clients : Homescreen. * @param[in] callback The callback function * @param[in] user_data The user data to be passed to the callback function * @return #BADGE_ERROR_NONE if success, other value if failure - * @retval BADGE_ERROR_NONE Success - * @retval BADGE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method - * @retval BADGE_ERROR_OUT_OF_MEMORY Out of memory - * @retval BADGE_ERROR_NOT_SUPPORTED Not supported + * @retval #BADGE_ERROR_NONE Success + * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method + * @retval #BADGE_ERROR_IO_ERROR Error from I/O + * @retval #BADGE_ERROR_OUT_OF_MEMORY Out of memory + * @retval #BADGE_ERROR_SERVICE_NOT_READY Service is not ready + * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported * @see #badge_error_e * @see badge_new() * @see badge_remove() @@ -351,11 +370,11 @@ int badge_register_changed_cb(badge_change_cb callback, void *user_data); * @privilege %http://tizen.org/privilege/notification * @param[in] callback The callback function * @return #BADGE_ERROR_NONE if success, other value if failure - * @retval BADGE_ERROR_NONE Success - * @retval BADGE_ERROR_INVALID_PARAMETER Invalid parameter - * @retval BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method - * @retval BADGE_ERROR_NOT_EXIST Not exist - * @retval BADGE_ERROR_NOT_SUPPORTED Not supported + * @retval #BADGE_ERROR_NONE Success + * @retval #BADGE_ERROR_INVALID_PARAMETER Invalid parameter + * @retval #BADGE_ERROR_PERMISSION_DENIED The application does not have the privilege to call this method + * @retval #BADGE_ERROR_NOT_EXIST Not exist + * @retval #BADGE_ERROR_NOT_SUPPORTED Not supported * @see #badge_error_e * @see badge_register_changed_cb() */ |