X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=include_product%2Fmedia_folder.h;h=b868cbf3e3d2338032967aed480b9b185f59eab2;hb=0bd93e228a808ce429cb72bec5f3de85e9e868d7;hp=0e06a16c133f1348ea4fe0aa8d88c25b5b68ac77;hpb=815f34758ac58cbf5449fb4a3618738bdbb97456;p=platform%2Fcore%2Fapi%2Fmedia-content.git

diff --git a/include_product/media_folder.h b/include_product/media_folder.h
index 0e06a16..b868cbf 100755
--- a/include_product/media_folder.h
+++ b/include_product/media_folder.h
@@ -15,8 +15,8 @@
 */
 
 
-#ifndef __TIZEN_MEDIA_FOLDER_H__
-#define __TIZEN_MEDIA_FOLDER_H__
+#ifndef __TIZEN_CONTENT_MEDIA_FOLDER_H__
+#define __TIZEN_CONTENT_MEDIA_FOLDER_H__
 
 
 #include <media_content_type.h>
@@ -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.
  */
 
 /**
@@ -43,10 +42,9 @@ extern "C" {
 
 /**
  * @brief Gets the count of folder for the passed @a filter from the media database.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
- * @param[in]  filter       The handle to filter \n
- *                          To allow searching over different content types, you should use #filter_h.
+ * @param[in] filter The handle to the media filter
  * @param[out] folder_count The count of the media folder
  *
  * @return @c 0 on success,
@@ -56,7 +54,6 @@ extern "C" {
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @pre This function requires opened connection to content service by media_content_connect().
  *
@@ -70,14 +67,12 @@ int media_folder_get_folder_count_from_db(filter_h filter, int *folder_count);
  *          The @a callback function will be invoked for every retrieved
  *          folder. If @c NULL is passed to the @a filter, no filtering is applied.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
- * @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 folder filter
- * @param[in] callback  The callback function to be invoked
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
  * @param[in] user_data The user data to be passed to the callback function
  *
  * @return @c 0 on success,
@@ -88,7 +83,6 @@ int media_folder_get_folder_count_from_db(filter_h filter, int *folder_count);
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @pre  This function requires opened connection to content service by media_content_connect().
  * @pre  A filter handle has to be created by calling media_filter_create().
@@ -101,11 +95,11 @@ int media_folder_get_folder_count_from_db(filter_h filter, int *folder_count);
 int media_folder_foreach_folder_from_db(filter_h filter, media_folder_cb callback, void *user_data);
 
 /**
- * @brief Gets the count of media files for the passed @a filter in the given @a folder from the media database.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @brief Gets the count of media files for the passed @a filter in the given @a folder_id from the media database.
+ * @since_tizen 2.3
  *
- * @param[in] folder_id    The ID of the media folder
- * @param[in] filter       The filter of the media content
+ * @param[in] folder_id The ID of the media folder
+ * @param[in] filter The handle to the media filter
  * @param[out] media_count The count of media folder items
  *
  * @return @c 0 on success,
@@ -115,7 +109,6 @@ int media_folder_foreach_folder_from_db(filter_h filter, media_folder_cb callbac
  * @retval #MEDIA_CONTENT_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @pre This function requires opened connection to content service by media_content_connect().
  *
@@ -124,21 +117,21 @@ int media_folder_foreach_folder_from_db(filter_h filter, media_folder_cb callbac
 int media_folder_get_media_count_from_db(const char *folder_id, filter_h filter, int *media_count);
 
 /**
- * @brief Iterates through the media files with an optional @a filter in the given @a folder from the media database.
+ * @brief Iterates through the media files with an optional @a filter in the given @a folder_id from the media database.
  * @details This function gets all media files associated with the given folder and
- *          meeting desired filter option and calls registered callback function for
+ *          meeting desired filter option and calls @a callback for
  *          every retrieved media item. If @c NULL is passed to the @a filter, no filtering is applied.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
- * @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.
  *
  * @param[in] folder_id The ID of the media folder
- * @param[in] filter    The handle to the media info filter
- * @param[in] callback  The callback function to be invoked
+ * @param[in] filter The handle to the media filter
+ * @param[in] callback The callback function to be invoked
  * @param[in] user_data The user data to be passed to the callback function
  *
  * @return @c 0 on success,
@@ -149,7 +142,6 @@ int media_folder_get_media_count_from_db(const char *folder_id, filter_h filter,
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED         DB Operation failed
  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY           DB Operation busy
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
  *
  * @pre  This function requires opened connection to content service by media_content_connect().
  * @post This function invokes media_info_cb().
@@ -167,12 +159,12 @@ int media_folder_foreach_media_from_db(const char *folder_id, filter_h filter, m
  *          media folder foreach function such as media_folder_foreach_folder_from_db(). To use this handle outside of these foreach functions,
  *          use this function.
  *
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
- * @remarks The destination handle must be released with media_folder_destroy().
+ * @remarks The @a dst should be released using media_folder_destroy().
  *
  * @param[out] dst The destination handle to the media folder
- * @param[in]  src The source handle to the media folder
+ * @param[in] src The source handle to the media folder
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -188,10 +180,10 @@ 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
+ * @since_tizen 2.3
  *
  * @param[in] folder The handle to the media folder
  *
@@ -209,11 +201,11 @@ int media_folder_destroy(media_folder_h folder);
 
 /**
  * @brief Gets the media folder ID.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
- * @remarks You must release @a folder_id using free().
+ * @remarks The @a folder_id should be released using free().
  *
- * @param[in]  folder    The handle to the media folder
+ * @param[in] folder The handle to the media folder
  * @param[out] folder_id The ID of the media folder
  *
  * @return @c 0 on success,
@@ -225,30 +217,13 @@ int media_folder_destroy(media_folder_h folder);
 int media_folder_get_folder_id(media_folder_h folder, char **folder_id);
 
 /**
- * @brief Gets the parent folder ID.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- *
- * @remarks You must release @a parent_folder_id 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);
-
-/**
  * @brief Gets the absolute path to the media folder.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
- * @remarks You must release @a path using free().
+ * @remarks The @a path should be released using free().
  *
- * @param[in]  folder The handle to the media folder
- * @param[out] path   The path of the media folder
+ * @param[in] folder The handle to the media folder
+ * @param[out] path The path of the media folder
  *
  * @return @c 0 on success,
  *         otherwise a negative error value
@@ -262,11 +237,11 @@ int media_folder_get_path(media_folder_h folder, char **path);
 
 /**
  * @brief Gets the media folder name.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
- * @remarks You must release @a folder_name using free().
+ * @remarks The @a folder_name should be released using free().
  *
- * @param[in]  folder      The handle to the media folder
+ * @param[in] folder The handle to the media folder
  * @param[out] folder_name The name of the media folder
  *
  * @return @c 0 on success,
@@ -279,91 +254,22 @@ int media_folder_get_path(media_folder_h folder, char **path);
 int media_folder_get_name(media_folder_h folder, char **folder_name);
 
 /**
- * @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 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);
-
-/**
- * @brief Gets the folder storage type.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @param[in]  folder       The handle to the media folder
- * @param[out] storage_type The storage type 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_storage_type(media_folder_h folder, media_content_storage_e *storage_type);
-
-/**
- * @brief Gets the storage id of the folder.
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- *
- * @remarks You must release @a storage_id using free().
- *
- * @param[in]  folder      The handle to the media folder
- * @param[out] storage_id The storage id 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_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;
-
-/**
  * @brief Gets the media folder from the media database.
  *
  * @details This function creates a new media folder handle from the media database by the given @a folder_id.
  *          Media folder will be created, which is filled with folder information.
- * @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @since_tizen 2.3
  *
- * @remarks You must release @a folder using media_folder_destroy().
+ * @remarks The @a folder should be released using media_folder_destroy().
  *
- * @param[in]  folder_id The ID of the media folder
- * @param[out] folder    The media folder handle associated with the folder ID
+ * @param[in] folder_id The ID of the media folder
+ * @param[out] 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_PERMISSION_DENIED Permission denied
  * @retval #MEDIA_CONTENT_ERROR_OUT_OF_MEMORY     Out of memory
  * @retval #MEDIA_CONTENT_ERROR_DB_FAILED DB Operation failed
  * @retval #MEDIA_CONTENT_ERROR_DB_BUSY DB Operation busy
@@ -377,80 +283,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
- * @retval #MEDIA_CONTENT_ERROR_PERMISSION_DENIED Permission denied
- */
-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;
-
-/**
  * @}
  */
 
@@ -458,4 +290,4 @@ int media_folder_update_to_db(media_folder_h folder) TIZEN_DEPRECATED_API;
 }
 #endif /* __cplusplus */
 
-#endif /* __TIZEN_MEDIA_FOLDER_H__ */
+#endif /* __TIZEN_CONTENT_MEDIA_FOLDER_H__ */