[ACR-1841] Deprecate badge api

Change-Id: I3a75197557f07bd658fcdc921cdb702560e0d57b
Signed-off-by: SukhyungKang <shine.kang@samsung.com>

diff --git a/doc/badge_doc.h b/doc/badge_doc.h
index 77f03ebb7166047c6dbd2f27ab32c3c21912c21e..dab7f360f60f70f2ddc82b11339d9b47b7c45798 100644 (file)
--- a/doc/badge_doc.h
+++ b/doc/badge_doc.h
@@ -23,7 +23,7 @@
 
 /**
  * @ingroup CAPI_APPLICATION_FRAMEWORK
- * @defgroup BADGE_MODULE Badge
+ * @defgroup BADGE_MODULE Badge (Deprecated)
  * @brief Badge APIs.
  * @section BADGE_MODULE_HEADER Required Header
  * \#include <badge.h>

diff --git a/include/badge.h b/include/badge.h
index 6fb53f0064d07a1ddfa665d5efb7c77a005cd4f6..df94893541fa81581d3d6e5f63449d1b9bd0f6d4 100644 (file)
--- a/include/badge.h
+++ b/include/badge.h
@@ -38,6 +38,7 @@ extern "C" {
  */
 
 /**
+ * @deprecated Deprecated since 9.0
  * @brief Enumeration for Badge Action.
  * @since_tizen 2.4
  */
@@ -82,6 +83,7 @@ enum badge_action {
 int badge_new(const char *writable_app_id) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0
  * @brief Creates a badge for the application specified by the badge_app_id.
  * @since_tizen 2.4
  * @privlevel public
@@ -112,9 +114,10 @@ int badge_new(const char *writable_app_id) TIZEN_DEPRECATED_API;
 }
  * @endcode
  */
-int badge_add(const char *badge_app_id);
+int badge_add(const char *badge_app_id) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0
  * @brief Removes the badge for the designated application.
  * @since_tizen 2.3
  * @privlevel public
@@ -145,9 +148,10 @@ int badge_add(const char *badge_app_id);
 }
  * @endcode
  */
-int badge_remove(const char *app_id);
+int badge_remove(const char *app_id) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0
  * @brief Sets badge count for the designated application.
  * @since_tizen 2.3
  * @privlevel public
@@ -180,9 +184,10 @@ int badge_remove(const char *app_id);
 }
  * @endcode
  */
-int badge_set_count(const char *app_id, unsigned int count);
+int badge_set_count(const char *app_id, unsigned int count) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0
  * @brief Gets badge count for the designated application.
  * @since_tizen 2.3
  * @privlevel public
@@ -217,9 +222,10 @@ int badge_set_count(const char *app_id, unsigned int count);
 }
  * @endcode
  */
-int badge_get_count(const char *app_id, unsigned int *count);
+int badge_get_count(const char *app_id, unsigned int *count) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0
  * @brief Sets the display option for the designated application.
  * @since_tizen 2.3
  * @privlevel public
@@ -252,9 +258,10 @@ int badge_get_count(const char *app_id, unsigned int *count);
 }
  * @endcode
  */
-int badge_set_display(const char *app_id, unsigned int is_display);
+int badge_set_display(const char *app_id, unsigned int is_display) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0
  * @brief Gets the display option for the designated application.
  * @since_tizen 2.3
  * @privlevel public
@@ -288,9 +295,10 @@ int badge_set_display(const char *app_id, unsigned int is_display);
 }
  * @endcode
  */
-int badge_get_display(const char *app_id, unsigned int *is_display);
+int badge_get_display(const char *app_id, unsigned int *is_display) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0
  * @brief Callback function for getting result of badge_foreach().
  * @since_tizen 2.4
  * @param[in] app_id The id of the application
@@ -304,6 +312,7 @@ typedef bool (*badge_foreach_cb)(const char *app_id, unsigned int count, void *u
 
 
 /**
+ * @deprecated Deprecated since 9.0
  * @brief Retrieves all existing badges.
  * @since_tizen 2.4
  * @privlevel public
@@ -323,9 +332,10 @@ typedef bool (*badge_foreach_cb)(const char *app_id, unsigned int count, void *u
  * @see #badge_error_e
  * @see badge_foreach_cb()
  */
-int badge_foreach(badge_foreach_cb callback, void *user_data);
+int badge_foreach(badge_foreach_cb callback, void *user_data) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0
  * @brief Called when the badge information is changed.
  * @since_tizen 2.4
  * @param[in] action The type of the change. Refer #badge_action
@@ -338,6 +348,7 @@ int badge_foreach(badge_foreach_cb callback, void *user_data);
 typedef void (*badge_change_cb)(unsigned int action, const char *app_id,
                        unsigned int count, void *user_data);
 /**
+ * @deprecated Deprecated since 9.0
  * @brief Registers a callback function to receive badge change event.
  * @since_tizen 2.4
  * @privlevel public
@@ -359,9 +370,10 @@ typedef void (*badge_change_cb)(unsigned int action, const char *app_id,
  * @see badge_remove()
  * @see badge_set_count()
  */
-int badge_register_changed_cb(badge_change_cb callback, void *user_data);
+int badge_register_changed_cb(badge_change_cb callback, void *user_data) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 9.0
  * @brief Unregisters a callback function to receive badge change event.
  * @since_tizen 2.4
  * @privlevel public
@@ -376,7 +388,7 @@ int badge_register_changed_cb(badge_change_cb callback, void *user_data);
  * @see #badge_error_e
  * @see badge_register_changed_cb()
  */
-int badge_unregister_changed_cb(badge_change_cb callback);
+int badge_unregister_changed_cb(badge_change_cb callback) TIZEN_DEPRECATED_API;
 
 /**
  * @}

diff --git a/include/badge_error.h b/include/badge_error.h
index fb823bf4e3840f3d513be36758e2953c092b8bd8..cbd48e1760e0e6998ab497f56379bcb2096e297d 100644 (file)
--- a/include/badge_error.h
+++ b/include/badge_error.h
@@ -36,6 +36,7 @@ extern "C" {
  */
 
 /**
+ * @deprecated Deprecated since 9.0
  * @brief Enumeration for Badge Error.
  * @since_tizen 2.3
  */

diff --git a/src/badge.cc b/src/badge.cc
index f651757bcd5c7133024645cc17e2ebd43c349df6..733c00a95cc7e3492ae43e20ac0b19f2dab58c16 100644 (file)
--- a/src/badge.cc
+++ b/src/badge.cc
@@ -92,6 +92,7 @@ void Connect() {
 }  // namespace
 
 EXPORT_API int badge_new(const char* writable_app_id) {
+  LOGW("DEPRECATION WARNING: badge_new() is deprecated and will be removed from next release.");
   CHECK_BADGE_FEATURE();
   if (writable_app_id == nullptr)
     return BADGE_ERROR_INVALID_PARAMETER;
@@ -111,6 +112,7 @@ EXPORT_API int badge_new(const char* writable_app_id) {
 }
 
 EXPORT_API int badge_add(const char* badge_app_id) {
+  LOGW("DEPRECATION WARNING: badge_add() is deprecated and will be removed from next release.");
   CHECK_BADGE_FEATURE();
   try {
     ::Connect();
@@ -127,6 +129,7 @@ EXPORT_API int badge_add(const char* badge_app_id) {
 }
 
 EXPORT_API int badge_remove(const char* app_id) {
+  LOGW("DEPRECATION WARNING: badge_remove() is deprecated and will be removed from next release.");
   CHECK_BADGE_FEATURE();
   try {
     ::Connect();
@@ -143,6 +146,7 @@ EXPORT_API int badge_remove(const char* app_id) {
 }
 
 EXPORT_API int badge_foreach(badge_foreach_cb callback, void* user_data) {
+  LOGW("DEPRECATION WARNING: badge_foreach() is deprecated and will be removed from next release.");
   CHECK_BADGE_FEATURE();
   if (callback == nullptr)
     return BADGE_ERROR_INVALID_PARAMETER;
@@ -165,6 +169,7 @@ EXPORT_API int badge_foreach(badge_foreach_cb callback, void* user_data) {
 }
 
 EXPORT_API int badge_set_count(const char* app_id, unsigned int count) {
+  LOGW("DEPRECATION WARNING: badge_set_count() is deprecated and will be removed from next release.");
   CHECK_BADGE_FEATURE();
   if (app_id == nullptr)
     return BADGE_ERROR_INVALID_PARAMETER;
@@ -183,6 +188,7 @@ EXPORT_API int badge_set_count(const char* app_id, unsigned int count) {
 }
 
 EXPORT_API int badge_get_count(const char* app_id, unsigned int* count) {
+  LOGW("DEPRECATION WARNING: badge_get_count() is deprecated and will be removed from next release.");
   CHECK_BADGE_FEATURE();
   if (app_id == nullptr || count == nullptr)
     return BADGE_ERROR_INVALID_PARAMETER;
@@ -201,6 +207,7 @@ EXPORT_API int badge_get_count(const char* app_id, unsigned int* count) {
 }
 
 EXPORT_API int badge_set_display(const char* app_id, unsigned int is_display) {
+  LOGW("DEPRECATION WARNING: badge_set_display() is deprecated and will be removed from next release.");
   CHECK_BADGE_FEATURE();
   if (app_id == nullptr)
     return BADGE_ERROR_INVALID_PARAMETER;
@@ -219,6 +226,7 @@ EXPORT_API int badge_set_display(const char* app_id, unsigned int is_display) {
 }
 
 EXPORT_API int badge_get_display(const char* app_id, unsigned int* is_display) {
+  LOGW("DEPRECATION WARNING: badge_get_display() is deprecated and will be removed from next release.");
   CHECK_BADGE_FEATURE();
   if (app_id == nullptr || is_display == nullptr)
     return BADGE_ERROR_INVALID_PARAMETER;
@@ -237,6 +245,7 @@ EXPORT_API int badge_get_display(const char* app_id, unsigned int* is_display) {
 }
 
 EXPORT_API int badge_register_changed_cb(badge_change_cb callback, void* data) {
+  LOGW("DEPRECATION WARNING: badge_register_changed_cb() is deprecated and will be removed from next release.");
   CHECK_BADGE_FEATURE();
   if (callback == nullptr)
     return BADGE_ERROR_INVALID_PARAMETER;
@@ -256,6 +265,7 @@ EXPORT_API int badge_register_changed_cb(badge_change_cb callback, void* data) {
 }
 
 EXPORT_API int badge_unregister_changed_cb(badge_change_cb callback) {
+  LOGW("DEPRECATION WARNING: badge_unregister_changed_cb() is deprecated and will be removed from next release.");
   CHECK_BADGE_FEATURE();
   if (callback == nullptr)
     return BADGE_ERROR_INVALID_PARAMETER;