* @class ContentTransfer
* @brief <i> [Deprecated] </i> 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:
* For full construction, the Construct(IContentTransferListener&) method must be called right after calling this constructor.
*
* @brief <i> [Deprecated] </i>
- * @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.
* This destructor overrides Tizen::Base::Object::~Object().
*
* @brief <i> [Deprecated] </i>
- * @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 %Construct() method should be called after every instance of %ContentTransfer is constructed.
*
* @brief <i> [Deprecated] </i>
- * @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
* @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()
*/
* When the data is being downloaded, the application is notified of the progress using the IContentTransferListener::OnContentTransferInProgress() method.
*
* @brief <i> [Deprecated] </i>
- * @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 <i> [Compatibility] </i>
* @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()
*/
/**
* @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 <i> [Deprecated] </i>
* @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 <i> [Deprecated] </i>
* @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()
*/
* @c 0 or minus second means unlimited period.
*
* @brief <i> [Deprecated] </i>
- * @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);
* Gets the default timeout period.
*
* @brief <i> [Deprecated] </i>
- * @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
* A download operation in progress is not removed by this operation.
*
* @brief <i> [Deprecated] </i>
- * @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);
* The download operations in progress are not removed by this operation.
*
* @brief <i> [Deprecated] </i>
- * @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);
/**
* 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 <i> [Deprecated] </i>
- * @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);
*
* @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);
* Gets the content transfer information list.
*
* @brief <i> [Deprecated] </i>
- * @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;
* Gets the list of transfers that are in progress.
*
* @brief <i> [Deprecated] </i>
- * @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 <i> [Deprecated] </i>
* @deprecated This class is deprecated. Instead of using this class, use DownloadManager class.
*
* @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);
projects / platform / framework / native / content.git / blobdiff