From 984969e49d2f46e86d5ca25260bf80329b7025d6 Mon Sep 17 00:00:00 2001 From: taesub kim Date: Fri, 21 Jul 2017 11:21:00 +0900 Subject: [PATCH] [ACR-1035] Added return value "DOWNLOAD_ERROR_NOT_SUPPORTED" Change-Id: Ic7f45de4d1b6bff4d6da4f2cffe8143727a4a232 Signed-off-by: Taesub Kim --- include/download.h | 52 ++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 46 insertions(+), 6 deletions(-) diff --git a/include/download.h b/include/download.h index 2a79ba3..6a37293 100755 --- a/include/download.h +++ b/include/download.h @@ -183,6 +183,7 @@ typedef void (*download_progress_cb) (int download_id, unsigned long long receiv * @retval #DOWNLOAD_ERROR_IO_ERROR Internal I/O error * @retval #DOWNLOAD_ERROR_QUEUE_FULL Download server queue is full * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @post The download state will be #DOWNLOAD_STATE_READY. * @@ -213,6 +214,7 @@ int download_create(int *download_id); * @retval #DOWNLOAD_ERROR_INVALID_PARAMETER Invalid parameter * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @see download_create() */ @@ -229,7 +231,7 @@ int download_destroy(int download_id); * @remarks This function should be called before downloading (see download_start()). * * @param[in] download_id The download ID - * @param[in] url The URL to download \n + * @param[in] url The URL to download \n * If @a url is @c NULL, it clears the previous value. * * @return @c 0 on success, @@ -241,6 +243,7 @@ int download_destroy(int download_id); * @retval #DOWNLOAD_ERROR_INVALID_STATE Invalid state * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre The state must be #DOWNLOAD_STATE_READY, #DOWNLOAD_STATE_FAILED, or #DOWNLOAD_STATE_CANCELED. * @@ -269,6 +272,7 @@ int download_set_url(int download_id, const char *url); * @retval #DOWNLOAD_ERROR_OUT_OF_MEMORY Out of memory * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @see download_set_url() */ @@ -324,6 +328,7 @@ int download_set_network_type(int download_id, download_network_type_e net_type) * @retval #DOWNLOAD_ERROR_INVALID_PARAMETER Invalid parameter * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @see download_set_network_type() * @see #download_network_type_e @@ -344,7 +349,7 @@ int download_get_network_type(int download_id, download_network_type_e *net_type * @remarks This function should be called before downloading (see download_start()). * * @param[in] download_id The download ID - * @param[in] path The absolute path to the downloaded file \n + * @param[in] path The absolute path to the downloaded file \n * If @a path is @c NULL, it clears the previous value. * * @return @c 0 on success, @@ -356,6 +361,7 @@ int download_get_network_type(int download_id, download_network_type_e *net_type * @retval #DOWNLOAD_ERROR_INVALID_STATE Invalid state * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre The state must be #DOWNLOAD_STATE_READY, #DOWNLOAD_STATE_FAILED, or #DOWNLOAD_STATE_CANCELED. * @@ -384,6 +390,7 @@ int download_set_destination(int download_id, const char *path); * @retval #DOWNLOAD_ERROR_OUT_OF_MEMORY Out of memory * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @see download_set_destination() */ @@ -403,7 +410,7 @@ int download_get_destination(int download_id, char **path); * @remarks This function should be called before downloading (see download_start()). * * @param[in] download_id The download ID - * @param[in] file_name The file name for the downloaded file \n + * @param[in] file_name The file name for the downloaded file \n * If @a name is @c NULL it clears the previous value. * * @return @c 0 on success, @@ -415,6 +422,7 @@ int download_get_destination(int download_id, char **path); * @retval #DOWNLOAD_ERROR_INVALID_STATE Invalid state * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre The state must be #DOWNLOAD_STATE_READY, #DOWNLOAD_STATE_FAILED, or #DOWNLOAD_STATE_CANCELED. * @@ -444,6 +452,7 @@ int download_set_file_name(int download_id, const char *file_name); * @retval #DOWNLOAD_ERROR_OUT_OF_MEMORY Out of memory * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @see download_set_file_name() */ @@ -471,6 +480,7 @@ int download_get_file_name(int download_id, char **file_name); * @retval #DOWNLOAD_ERROR_OUT_OF_MEMORY Out of memory * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre The download state must be #DOWNLOAD_STATE_COMPLETED. * @@ -501,6 +511,7 @@ int download_get_downloaded_file_path(int download_id, char **path); * @retval #DOWNLOAD_ERROR_OUT_OF_MEMORY Out of memory * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @see download_set_file_name() * @see download_set_destination() @@ -534,6 +545,7 @@ int download_get_mime_type(int download_id, char **mime_type); * @retval #DOWNLOAD_ERROR_INVALID_PARAMETER Invalid parameter * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre The state must be #DOWNLOAD_STATE_READY, #DOWNLOAD_STATE_FAILED, or #DOWNLOAD_STATE_CANCELED. * @@ -553,7 +565,7 @@ int download_set_auto_download(int download_id, bool enable); * @privilege %http://tizen.org/privilege/download * * @param[in] download_id The download ID - * @param[out] enable @c true if auto download is enabled, + * @param[out] enable @c true if auto download is enabled, * otherwise @c false if auto download is disabled * * @return @c 0 on success, @@ -563,6 +575,7 @@ int download_set_auto_download(int download_id, bool enable); * @retval #DOWNLOAD_ERROR_INVALID_PARAMETER Invalid parameter * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @see download_set_auto_download() */ @@ -597,6 +610,7 @@ int download_get_auto_download(int download_id, bool *enable); * @retval #DOWNLOAD_ERROR_IO_ERROR Internal I/O error * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre The state must be #DOWNLOAD_STATE_READY, #DOWNLOAD_STATE_FAILED, or #DOWNLOAD_STATE_CANCELED. * @@ -630,6 +644,7 @@ int download_add_http_header_field(int download_id, const char *field, const cha * @retval #DOWNLOAD_ERROR_FIELD_NOT_FOUND Specified field not found * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @see download_add_http_header_field() * @see download_remove_http_header_field() @@ -658,6 +673,7 @@ int download_get_http_header_field(int download_id, const char *field, char **va * @retval #DOWNLOAD_ERROR_INVALID_STATE Invalid state * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @see download_add_http_header_field() * @see download_remove_http_header_field() @@ -688,6 +704,7 @@ int download_get_http_header_field_list(int download_id, char ***fields, int *le * @retval #DOWNLOAD_ERROR_IO_ERROR Internal I/O error * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre The state must be #DOWNLOAD_STATE_READY, #DOWNLOAD_STATE_FAILED, or #DOWNLOAD_STATE_CANCELED. * @@ -710,13 +727,14 @@ int download_remove_http_header_field(int download_id, const char *field); * @param[in] callback The callback function to register * @param[in] user_data The user data to be passed to the callback function * - * @return @c 0 on success, + * @return @c 0 on success, * otherwise a negative error value * * @retval #DOWNLOAD_ERROR_NONE Successful * @retval #DOWNLOAD_ERROR_INVALID_PARAMETER Invalid parameter * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @post download_state_changed_cb() will be invoked. * @@ -744,6 +762,7 @@ int download_set_state_changed_cb(int download_id, download_state_changed_cb cal * @retval #DOWNLOAD_ERROR_INVALID_PARAMETER Invalid parameter * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @see download_set_state_changed_cb() * @see download_state_changed_cb() @@ -772,6 +791,7 @@ int download_unset_state_changed_cb(int download_id); * @retval #DOWNLOAD_ERROR_INVALID_STATE Invalid state * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @post download_progress_cb() will be invoked. * @@ -800,6 +820,7 @@ int download_set_progress_cb(int download_id, download_progress_cb callback, voi * @retval #DOWNLOAD_ERROR_INVALID_STATE Invalid state * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @see download_set_progress_cb() * @see download_progress_cb() @@ -835,6 +856,7 @@ int download_unset_progress_cb(int download_id); * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_QUEUE_FULL Download server queue is full * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre The download state must be #DOWNLOAD_STATE_READY, #DOWNLOAD_STATE_PAUSED, #DOWNLOAD_STATE_CANCELED, or #DOWNLOAD_STATE_FAILED. * @post The download state will be #DOWNLOAD_STATE_QUEUED or #DOWNLOAD_STATE_DOWNLOADING. @@ -867,6 +889,7 @@ int download_start(int download_id); * @retval #DOWNLOAD_ERROR_IO_ERROR Internal I/O error * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre The download state must be #DOWNLOAD_STATE_DOWNLOADING. * @post The download state will be #DOWNLOAD_STATE_PAUSED. @@ -900,6 +923,7 @@ int download_pause(int download_id); * @retval #DOWNLOAD_ERROR_IO_ERROR Internal I/O error * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre The download state must be #DOWNLOAD_STATE_QUEUED, #DOWNLOAD_STATE_DOWNLOADING, or #DOWNLOAD_STATE_PAUSED. * @post The download state will be #DOWNLOAD_STATE_CANCELED. @@ -926,6 +950,7 @@ int download_cancel(int download_id); * @retval #DOWNLOAD_ERROR_INVALID_PARAMETER Invalid parameter * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @see #download_state_e */ @@ -949,6 +974,7 @@ int download_get_state(int download_id, download_state_e *state); * @retval #DOWNLOAD_ERROR_INVALID_PARAMETER Invalid parameter * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre The download state must be one of the states after #DOWNLOAD_STATE_DOWNLOADING. * @@ -981,6 +1007,7 @@ int download_get_temp_path(int download_id, char **temp_path); * @retval #DOWNLOAD_ERROR_INVALID_PARAMETER Invalid parameter * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre The state must be #DOWNLOAD_STATE_READY, #DOWNLOAD_STATE_FAILED, or #DOWNLOAD_STATE_CANCELED. * @@ -1009,6 +1036,7 @@ int download_set_temp_file_path(int download_id, char *path); * @retval #DOWNLOAD_ERROR_INVALID_PARAMETER Invalid parameter * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre The download state must be one of the states after #DOWNLOAD_STATE_DOWNLOADING. * @@ -1038,6 +1066,7 @@ int download_get_content_name(int download_id, char **content_name); * @retval #DOWNLOAD_ERROR_INVALID_PARAMETER Invalid parameter * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre The download state must be one of the states after #DOWNLOAD_STATE_DOWNLOADING. * @@ -1065,6 +1094,7 @@ int download_get_content_size(int download_id, unsigned long long *content_size) * @retval #DOWNLOAD_ERROR_INVALID_PARAMETER Invalid parameter * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre The download state must be #DOWNLOAD_STATE_FAILED. * @pre The download state must be #DOWNLOAD_STATE_CANCELED. @@ -1094,6 +1124,7 @@ int download_get_error(int download_id, download_error_e *error); * @retval #DOWNLOAD_ERROR_INVALID_PARAMETER Invalid parameter * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre The download state must be #DOWNLOAD_STATE_FAILED. * @@ -1131,6 +1162,7 @@ int download_get_http_status(int download_id, int *HTTP_status); * @retval #DOWNLOAD_ERROR_INVALID_PARAMETER Invalid parameter * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre The state must be #DOWNLOAD_STATE_READY, #DOWNLOAD_STATE_FAILED, or #DOWNLOAD_STATE_CANCELED. * @@ -1164,6 +1196,7 @@ int download_set_notification_app_control(int download_id, download_notification * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_NO_DATA The app control handle has not been set * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @see download_set_notification_app_control() */ @@ -1189,6 +1222,7 @@ int download_get_notification_app_control(int download_id, download_notification * @retval #DOWNLOAD_ERROR_INVALID_PARAMETER Invalid parameter * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre If a notification option is not enabled, this title is not shown to user. * @@ -1218,6 +1252,7 @@ int download_set_notification_title(int download_id, const char *title); * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_NO_DATA The title has not been set * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre It can get the title value before calling this API. * @@ -1245,6 +1280,7 @@ int download_get_notification_title(int download_id, char **title); * @retval #DOWNLOAD_ERROR_INVALID_PARAMETER Invalid parameter * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre If the notification option is not enabled, this description is not shown to user. * @@ -1274,6 +1310,7 @@ int download_set_notification_description(int download_id, const char *descripti * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_NO_DATA The description has not been set * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre It can get the title value before calling this API. * @@ -1308,6 +1345,7 @@ int download_get_notification_description(int download_id, char **description); * @retval #DOWNLOAD_ERROR_INVALID_PARAMETER Invalid parameter * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @pre The state must be #DOWNLOAD_STATE_READY, #DOWNLOAD_STATE_FAILED, or #DOWNLOAD_STATE_CANCELED. * @@ -1328,7 +1366,7 @@ int download_set_notification_type(int download_id, download_notification_type_e * The default type is #DOWNLOAD_NOTIFICATION_TYPE_NONE. * * @param[in] download_id The download ID - * @param[out] type The enumeration type \n + * @param[out] type The enumeration type \n * See #download_notification_type_e. * * @return @c 0 on success, @@ -1338,6 +1376,7 @@ int download_set_notification_type(int download_id, download_notification_type_e * @retval #DOWNLOAD_ERROR_INVALID_PARAMETER Invalid parameter * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @see download_set_notification_type() */ @@ -1364,6 +1403,7 @@ int download_get_notification_type(int download_id, download_notification_type_e * @retval #DOWNLOAD_ERROR_INVALID_PARAMETER Invalid parameter * @retval #DOWNLOAD_ERROR_ID_NOT_FOUND No download ID * @retval #DOWNLOAD_ERROR_PERMISSION_DENIED Permission denied + * @retval #DOWNLOAD_ERROR_NOT_SUPPORTED Not supported * * @see download_set_temp_file_path() */ -- 2.7.4