Fix incorrect description
[platform/core/api/media-content.git] / include / media_folder.h
index a0a87bc..6fbbe94 100755 (executable)
@@ -31,8 +31,7 @@ extern "C" {
  * @brief This file contains API related to all operations with media folder in DB. \n
  *        These functions include getting the number of folders and media files filtered from DB,  \n
  *        iterating through media files and folders filtered in the given folder from DB;  \n
- *        cloning and destroying the media folder, getting its name, ID, absolute path and date \n
- *        and updating the media folder to the media database.
+ *        cloning and destroying the media folder, getting its name, ID, absolute path.
  */
 
 /**
@@ -70,9 +69,7 @@ int media_folder_get_folder_count_from_db(filter_h filter, int *folder_count);
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks Do not call updating DB fuction like media_folder_update_to_db() in your callback function, your callback function is invoked as inline function.\n
- *                   So, your callback function is in read state in SQLite. When you are in read state, sometimes you do not update DB. \n
- *                   We do not recommend you call updating DB function in callback of foreach function.
+ * @remarks We do not recommend you call updating DB function in callback of foreach function.
  *
  * @param[in] filter The handle to the media filter
  * @param[in] callback The callback function to be invoked
@@ -127,7 +124,7 @@ int media_folder_get_media_count_from_db(const char *folder_id, filter_h filter,
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
- * @remarks   Do not call updating DB function like media_info_update_to_db(), media_info_refresh_metadata_to_db(), audio_meta_update_to_db(), image_meta_update_to_db() and video_meta_update_to_db()  in your callback function,
+ * @remarks   Do not call updating DB function like media_info_update_to_db() in your callback function,
  *                    your callback function is invoked as inline function. \n
  *                    So, your callback function is in read state in SQLite. When you are in read state, sometimes you do not update DB. \n
  *                    We do not recommend you call updating DB function in callback of foreach function.
@@ -183,7 +180,7 @@ int media_folder_clone(media_folder_h *dst, media_folder_h src);
 /**
  * @brief Destroys the media folder.
  * @details The function frees all resources related to the folder handle. This handle
- *          no longer can be used to perform any operation. A new handle has to
+ *          no longer can be used to perform any operations. A new handle has to
  *          be created before the next use.
  *
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
@@ -220,24 +217,6 @@ int media_folder_destroy(media_folder_h folder);
 int media_folder_get_folder_id(media_folder_h folder, char **folder_id);
 
 /**
- * @deprecated Deprecated since 4.0.
- * @brief Gets the parent folder ID.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- *
- * @remarks The @a parent_folder_id should be released using free().
- *
- * @param[in] folder The handle to the media folder
- * @param[out] parent_folder_id The ID of the upper media folder
- *
- * @return @c 0 on success,
- *         otherwise a negative error value
- *
- * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- */
-int media_folder_get_parent_folder_id(media_folder_h folder, char **parent_folder_id) TIZEN_DEPRECATED_API;
-
-/**
  * @brief Gets the absolute path to the media folder.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
@@ -275,22 +254,7 @@ int media_folder_get_path(media_folder_h folder, char **path);
 int media_folder_get_name(media_folder_h folder, char **folder_name);
 
 /**
- * @deprecated Deprecated since 4.0.
- * @brief Gets the modified date of the folder.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @param[in] folder The handle to the media folder
- * @param[out] date The modified date of the media folder
- *
- * @return @c 0 on success,
- *         otherwise a negative error value
- *
- * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- */
-int media_folder_get_modified_time(media_folder_h folder, time_t *date) TIZEN_DEPRECATED_API;
-
-/**
+ * @deprecated Deprecated since 5.0. Use storage_get_type_dev() instead.
  * @brief Gets the folder storage type.
  * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
  *
@@ -303,9 +267,10 @@ int media_folder_get_modified_time(media_folder_h folder, time_t *date) TIZEN_DE
  * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  */
-int media_folder_get_storage_type(media_folder_h folder, media_content_storage_e *storage_type);
+int media_folder_get_storage_type(media_folder_h folder, media_content_storage_e *storage_type) TIZEN_DEPRECATED_API;
 
 /**
+ * @deprecated Deprecated since 5.0.
  * @brief Gets the storage id of the folder.
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  *
@@ -321,27 +286,7 @@ int media_folder_get_storage_type(media_folder_h folder, media_content_storage_e
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
  */
-int media_folder_get_storage_id(media_folder_h folder, char **storage_id);
-
-/**
- * @deprecated Deprecated since 4.0. \n
- *         This function does not guarantee order independence between applications. It is recommended that the viewing order is managed by the application.
- *
- * @brief Gets the folder viewing order.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- *
- * @param[in] folder The handle to the media folder
- * @param[out] order The viewing order of the media folder
- *
- * @return @c 0 on success,
- *         otherwise a negative error value
- *
- * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- *
- * @post media_folder_update_to_db()
- */
-int media_folder_get_order(media_folder_h folder, int *order) TIZEN_DEPRECATED_API;
+int media_folder_get_storage_id(media_folder_h folder, char **storage_id) TIZEN_DEPRECATED_API;
 
 /**
  * @brief Gets the media folder from the media database.
@@ -373,79 +318,6 @@ int media_folder_get_order(media_folder_h folder, int *order) TIZEN_DEPRECATED_A
 int media_folder_get_folder_from_db(const char *folder_id, media_folder_h *folder);
 
 /**
- * @deprecated Deprecated since 4.0. Use media_content_scan_folder() or media_info_move_to_db() instead.
- * @brief Sets the folder name.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @param[in] folder The handle to the media folder
- * @param[in] name The name of the media folder
- *
- * @return @c 0 on success,
- *         otherwise a negative error value
- *
- * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
- */
-int media_folder_set_name(media_folder_h folder, const char *name) TIZEN_DEPRECATED_API;
-
-/**
- * @deprecated Deprecated since 4.0. \n
- *         This function does not guarantee order independence between applications. It is recommended that the viewing order is managed by the application.
- * @brief Sets the folder viewing order.
- * @details If you set the order value for each folder, you can sort in ascending or descending order as the set order values using the filter. \n
- *                 Moreover, more detailed settings are possible when used with the filter. \n
- *
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- * @remarks  If you don't set the order value, the order value will be set default value. Default is 0. \n
- *                    If you don't use the filter, the set order value does not effect the folder viewing order.
- *
- * @param[in] folder The handle to the media folder
- * @param[in] order The viewing order of the media folder
- *
- * @return @c 0 on success,
- *         otherwise a negative error value
- *
- * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- */
-int media_folder_set_order(media_folder_h folder, int order) TIZEN_DEPRECATED_API;
-
-/**
- * @deprecated Deprecated since 4.0. Related setter functions are deprecated, therefore this function is not needed anymore.
- * @brief Updates the media folder to the media database.
- *
- * @details The function updates the given media folder in the media database. The function should be called after any change in folder attributes, to be updated to the media
- *          database.
- *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @privlevel public
- * @privilege %http://tizen.org/privilege/content.write
- *
- * @param[in] folder The handle to the media folder
- *
- * @return @c 0 on success,
- *         otherwise a negative error value
- *
- * @retval #MEDIA_CONTENT_ERROR_NONE              Successful
- * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
- * @retval #MEDIA_CONTENT_ERROR_INVALID_OPERATION Invalid operation
- * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
- * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
- * @retval #MEDIA_CONTENT_ERROR_NETWORK           Network fail
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- *
- * @pre This function requires opened connection to content service by media_content_connect().
- *
- * @see media_content_connect()
- * @see media_folder_destroy()
- */
-int media_folder_update_to_db(media_folder_h folder) TIZEN_DEPRECATED_API;
-
-/**
  * @}
  */