X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFCntContentTransfer.h;h=e2a3d1171ce6d8dbf8c6bc58d4b3d2d065720b52;hb=refs%2Fchanges%2F35%2F14235%2F1;hp=2684c3c577cbf3ffbb21d5d42a70ba62076afcdd;hpb=3960e13122252d09dd887567dbdfe67e20eb5613;p=platform%2Fframework%2Fnative%2Fcontent.git diff --git a/inc/FCntContentTransfer.h b/inc/FCntContentTransfer.h index 2684c3c..e2a3d11 100644 --- a/inc/FCntContentTransfer.h +++ b/inc/FCntContentTransfer.h @@ -48,7 +48,7 @@ class IContentTransferListener; * @class ContentTransfer * @brief [Deprecated] This class provides methods to download the content. * - * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class. + * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class. * @since 2.0 * * The %ContentTransfer class provides the following features: @@ -124,7 +124,7 @@ public: * For full construction, the Construct(IContentTransferListener&) method must be called right after calling this constructor. * * @brief [Deprecated] - * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class. + * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class. * @since 2.0 * * @remarks After creating an instance of this class, the Construct() method must be called explicitly to initialize this instance. @@ -135,7 +135,7 @@ public: * This destructor overrides Tizen::Base::Object::~Object(). * * @brief [Deprecated] - * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class. + * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class. * * @since 2.0 */ @@ -146,7 +146,7 @@ public: * The %Construct() method should be called after every instance of %ContentTransfer is constructed. * * @brief [Deprecated] - * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class. + * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class. * @since 2.0 * * @return An error code @@ -174,26 +174,26 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/download * - * @return An error code - * @param[in] uri The content URL - * @param[in] fileSize The content file size in bytes @n - * If set to @c 0, the method does not check the storage limitation. - * @param[in] destFilePath The full destination path - * @param[in] replace The replace option of the destination file @n - * Set to @c true to replace the file, @n - * else @c false. - * @param[out] reqId The request ID - * @param[in] pListener A pointer to the IContentTransferListener instance - * @param[in] sec The timeout period in seconds + * @return An error code + * @param[in] uri The content URL + * @param[in] fileSize The content file size in bytes @n + * If set to @c 0, the method does not check the storage limitation. + * @param[in] destFilePath The full destination path + * @param[in] replace The replace option of the destination file @n + * Set to @c true to replace the file, @n + * else @c false. + * @param[out] reqId The request ID + * @param[in] pListener A pointer to the IContentTransferListener instance + * @param[in] sec The timeout period in seconds * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_INVALID_STATE This method is invalid for the current state of this instance. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_INVALID_STATE This method is invalid for the current state of this instance. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_FILE_ALREADY_EXIST The specified file already exists. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_IN_PROGRESS A previous request is in progress. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @see IContentTransferListener::OnContentDownloadCompleted() * @see IContentTransferListener::OnContentTransferInProgress() */ @@ -209,41 +209,44 @@ public: * When the data is being downloaded, the application is notified of the progress using the IContentTransferListener::OnContentTransferInProgress() method. * * @brief [Deprecated] - * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class. + * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class. * @if OSPCOMPAT * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompContentTransferDownloadPage3 "here". + * For more information, see @ref CompContentTransferDownloadPage3 "here". * @endif - * @privlevel public - * @privilege %http://tizen.org/privilege/download + * @privlevel public + * @privilege %http://tizen.org/privilege/download * - * @return An error code - * @param[in] uri The content URL - * @param[in] filePath The destination file path @n - * Use Tizen::System::Environment::GetMediaPath(), Tizen::System::Environment::GetExternalStoragePath() and Tizen::App::App::GetInstance()->GetAppRootPath(). - * @param[out] reqId The request ID - * @param[in] replace The replace option of the destination file @n - * Set to @c true to replace the file, @n + * @return An error code + * @param[in] uri The content URL + * @param[in] filePath The destination file path @n + * Use Tizen::System::Environment::GetMediaPath(), Tizen::System::Environment::GetExternalStoragePath() and Tizen::App::App::GetInstance()->GetAppRootPath(). + * @param[out] reqId The request ID + * @param[in] replace The replace option of the destination file @n + * Set to @c true to replace the file, @n * else @c false. - * @param[in] timeout The timeout period in seconds - * @param[in] progressInterval The progress period interval as a percentage value - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_INVALID_STATE This method is invalid for the current state of this instance. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. - * @exception E_FILE_ALREADY_EXIST The specified file already exists. - * @exception E_IN_PROGRESS A previous request is in progress. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @param[in] timeout The timeout period in seconds + * @param[in] progressInterval The progress period interval as a percentage value + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_INVALID_STATE This method is invalid for the current state of this instance. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. + * @exception E_FILE_ALREADY_EXIST The specified file already exists. + * @exception E_IN_PROGRESS A previous request is in progress. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_SYSTEM A system error has occurred. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @remarks - * - The @c progressInterval is the interval of the progress for each download request. If the value of the @c progressInterval is @c 0, the @c progressInterval uses the value set by the ContentTransfer::SetProgressIntervalByPercent(int). The @c progressInterval is a percentage value between @c 0 and @c 100. - * - The @c timeout is the value of the response timeout for each download request. If the value of the @c timeout is @c 0, the value for the @c timeout uses the value set by the ContentTransfer::SetDefaultTimeout(int). + * - The @c progressInterval is the interval of the progress for each download request. If the value of the @c progressInterval is @c 0, the + * @c progressInterval uses the value set by the ContentTransfer::SetProgressIntervalByPercent(int). The @c progressInterval is a percentage + * value between @c 0 and @c 100. + * - The @c timeout is the value of the response timeout for each download request. If the value of the @c timeout is @c 0, the value for the + * @c timeout uses the value set by the ContentTransfer::SetDefaultTimeout(int). * @see IContentTransferListener::OnContentDownloadCompleted() * @see IContentTransferListener::OnContentTransferInProgress() */ @@ -251,82 +254,85 @@ public: /** * @if OSPCOMPAT - * @page CompContentTransferDownloadPage3 Compatibility for the file path. + * @page CompContentTransferDownloadPage3 Compatibility for the file path. * @section CompContentTransferDownloadPageIssueSection Issues - * The content path argument of this method in OSP compatible applications has the following issues: @n - * -# The content path should be a path that begins with an allowed path prefix. @n - * For example, L"/Media/Images/flower.jpg", "/Storagecard/Media/Images/flower.jpg". + * The content path argument of this method in OSP compatible applications has the following issues: @n + * -# The content path should be a path that begins with an allowed path prefix. @n + * For example, L"/Media/Images/flower.jpg", "/Storagecard/Media/Images/flower.jpg". * * @section CompImageContentInfoConstructPageSolutionSection Resolutions - * This issue has been resolved in Tizen. @n - * -# The content path can be a path without a specific allowed path prefix. @n - * Application do not need to know the specific allowed path prefixes. @n - * To get the directory path, use the following methods: @n - * - For accessing the media directory, use Tizen::System::Environment::GetMediaPath(). - * - For accessing the external storage, use Tizen::System::Environment::GetExternalStoragePath(). + * This issue has been resolved in Tizen. @n + * -# The content path can be a path without a specific allowed path prefix. @n + * Applications do not need to know the specific allowed path prefixes. @n + * To get the directory path, use the following methods: @n + * - For accessing the media directory, use Tizen::System::Environment::GetMediaPath(). + * - For accessing the external storage, use Tizen::System::Environment::GetExternalStoragePath(). * * @endif */ /** - * Downloads a content file to a buffer from the content provider's servers. @n + * Downloads a content file from the content provider's servers into a buffer. @n * The %DownloadToBuffer() method does not register the content. @n * When the download is completed, the application is notified using the IContentTransferListener::OnContentDownloadToBufferCompleted() method. @n * When the data is being downloaded, the application is notified of the progress using the IContentTransferListener::OnContentTransferInProgress() method. * * @brief [Deprecated] * @deprecated This method is deprecated due to the operation policy of the Tizen Server. - * When downloading the contents to a buffer from a third party server, it is recommended to use the DownloadToBuffer(const Tizen::Base::Utility::Uri&, RequestId&, int, int) method. - * @since 2.0 + * When downloading the contents into a buffer from a third party server, it is recommended to use the DownloadToBuffer(const Tizen::Base::Utility::Uri&, RequestId&, int, int) method. + * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/download * * @return An error code - * @param[in] uri The content URL - * @param[in] fileSize The content file size in bytes @n - * If set to @c 0, the method does not check the storage limitation. - * @param[out] reqId The request ID - * @param[in] pListener A pointer to the IContentTransferListener instance - * @param[in] sec The timeout period in seconds + * @param[in] uri The content URL + * @param[in] fileSize The content file size in bytes @n + * If set to @c 0, the method does not check the storage limitation. + * @param[out] reqId The request ID + * @param[in] pListener A pointer to the IContentTransferListener instance + * @param[in] sec The timeout period in seconds * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_INVALID_STATE This method is invalid for the current state of this instance. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_INVALID_STATE This method is invalid for the current state of this instance. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @see IContentTransferListener::OnContentDownloadToBufferCompleted() * @see IContentTransferListener::OnContentTransferInProgress() */ result DownloadToBuffer(const Tizen::Base::Utility::Uri& uri, int fileSize, RequestId& reqId, IContentTransferListener* pListener = null, int sec = 0); /** - * Downloads a content file to a buffer from the content provider's servers. @n + * Downloads a content file from the content provider's servers into a buffer . @n * The %DownloadToBuffer() method does not register the content. @n * When the download is completed, the application is notified using the IContentTransferListener::OnContentDownloadToBufferCompleted() method. @n * When the data is being downloaded, the application is notified of the progress using the IContentTransferListener::OnContentTransferInProgress() method. * * @brief [Deprecated] * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class. - * @since 2.0 - * @privlevel public - * @privilege %http://tizen.org/privilege/download + * @since 2.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/download * - * @return An error code + * @return An error code * @param[in] uri The content URL * @param[out] reqId The request ID * @param[in] timeout The timeout period in seconds * @param[in] progressInterval The progress period interval as a percentage value * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_INVALID_STATE This method is invalid for the current state of this instance. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_INVALID_STATE This method is invalid for the current state of this instance. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_IN_PROGRESS A previous request is in progress. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @remarks - * - The @c progressInterval is the interval of the progress for each download request. If the value of the @c progressInterval is @c 0, the @c progressInterval uses the value set by the ContentTransfer::SetProgressIntervalByPercent(int). The @c progressInterval is a percentage value between @c 0 and @c 100. - * - The @c timeout is the value of the response timeout for each download request. If the value of the @c timeout is @c 0, the value for the @c timeout uses the value set by the ContentTransfer::SetDefaultTimeout(int). + * - The @c progressInterval is the interval of the progress for each download request. If the value of the @c progressInterval is @c 0, the + * @c progressInterval uses the value set by the ContentTransfer::SetProgressIntervalByPercent(int). The @c progressInterval is a percentage + * value between @c 0 and @c 100. + * - The @c timeout is the value of the response timeout for each download request. If the value of the @c timeout is @c 0, the value for the + * @c timeout uses the value set by the ContentTransfer::SetDefaultTimeout(int). * @see IContentTransferListener::OnContentDownloadToBufferCompleted() * @see IContentTransferListener::OnContentTransferInProgress() */ @@ -338,11 +344,11 @@ public: * @c 0 or minus second means unlimited period. * * @brief [Deprecated] - * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class. + * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class. * @since 2.0 * * @param[in] sec The default timeout period in seconds @n - * The default value is @c 0. + * The default value is @c 0 */ void SetDefaultTimeout(int sec); @@ -350,7 +356,7 @@ public: * Gets the default timeout period. * * @brief [Deprecated] - * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class. + * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class. * @since 2.0 * * @return The default timeout period @@ -363,15 +369,15 @@ public: * A download operation in progress is not removed by this operation. * * @brief [Deprecated] - * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class. + * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class. * @since 2.0 * * @return An error code - * @param[in] reqId The request ID + * @param[in] reqId The request ID * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_OBJ_NOT_FOUND The specified @c reqId is not found. - * @exception E_INVALID_STATE This method is invalid for the current state of this instance. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_OBJ_NOT_FOUND The specified @c reqId is not found. + * @exception E_INVALID_STATE This method is invalid for the current state of this instance. * @remarks To stop an on-going transfer, use the Cancel() method. */ result Remove(RequestId reqId); @@ -382,13 +388,13 @@ public: * The download operations in progress are not removed by this operation. * * @brief [Deprecated] - * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class. + * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class. * @since 2.0 * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_STATE This method is invalid for the current state of this instance. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_STATE This method is invalid for the current state of this instance. * @remarks To stop an on-going transfer, use the Cancel() method. */ result RemoveAll(void); @@ -396,18 +402,18 @@ public: /** * Cancels a transfer operation. @n * The downloaded file is deleted from the file system. @n - * When a transfer download operation is canceled, the application is notified via the IContentTransferListener::OnContentTransferCanceled() method. + * When a transfer download operation is cancelled, the application is notified through the IContentTransferListener::OnContentTransferCanceled() method. * * @brief [Deprecated] - * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class. + * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class. * @since 2.0 * * @return An error code - * @param[in] reqId The request ID + * @param[in] reqId The request ID * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c reqId is not found. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_INVALID_STATE This method is invalid for the current state of this instance. + * @exception E_INVALID_STATE This method is invalid for the current state of this instance. * @see IContentTransferListener::OnContentTransferCanceled() */ result Cancel(RequestId reqId); @@ -421,8 +427,8 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_STATE This method is invalid for the current state of this instance. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_STATE This method is invalid for the current state of this instance. */ result CancelAll(void); @@ -430,11 +436,11 @@ public: * Gets the content transfer information list. * * @brief [Deprecated] - * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class. + * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class. * @since 2.0 * - * @return A pointer to a list containing the ContentTransferInfo instances, @n - * else an empty list if there is no result and no error + * @return A pointer to the list that contains the ContentTransferInfo instances, @n + * else an empty list is returned if there is no result or error */ Tizen::Base::Collection::IList* GetContentTransferInfoListN(void) const; @@ -442,18 +448,18 @@ public: * Gets the list of transfers that are in progress. * * @brief [Deprecated] - * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class. + * @deprecated This class is deprecated. Instead of using this class, use the DownloadManager class. * @since 2.0 * - * @return A pointer to a list containing the ContentTransferInfo instances, @n - * else an empty list if there is no result and no error + * @return A pointer to the list that contains the ContentTransferInfo instances, @n + * else an empty list is retuned if there is no result or error */ Tizen::Base::Collection::IList* GetContentTransferInfoListInProgressN(void) const; /** * Sets the interval of the progress. @n * The input is a percentage value between @c 0 and @c 100. The default value is @c 0. - * @c 0 means the application would not receive progress events. + * @c 0 means the application does not receive progress events. * * @brief [Deprecated] * @deprecated This class is deprecated. Instead of using this class, use DownloadManager class. @@ -461,7 +467,7 @@ public: * * @param[in] percent The progress period interval as a percentage value * @remarks If a server does not provide the information about the content size, then the content module cannot verify the information. @n - * In that case, progress event will occur randomly. + * In that case, the progress event will occur randomly. */ void SetProgressIntervalByPercent(int percent);