doc/download_doc.h

   1 /*
   2  * Copyright (c) 2011 Samsung Electronics Co., Ltd All Rights Reserved
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the License);
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an AS IS BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef __TIZEN_WEB_DOWNLOAD_DOC_H__
  18 #define __TIZEN_WEB_DOWNLOAD_DOC_H__
  19
  20 /**
  21  * @ingroup CAPI_CONTENT_FRAMEWORK
  22  * @defgroup CAPI_WEB_DOWNLOAD_MODULE Download
  23  * @brief  The DOWNLOAD API provides functions to create and manage one or more download requests.
  24  *
  25  * @section CAPI_WEB_DOWNLOAD_MODULE_HEADER Required Header
  26  *   \#include <download.h>
  27  *
  28  * @section CAPI_WEB_DOWNLOAD_MODULE_OVERVIEW Overview
  29  * The DOWNLOAD API provides functions to create and manage one or more download requests.
  30  *
  31  * Major features :
  32  * - After getting @a download_id from download_create(), other APIs use @a download_id as parameter.
  33  * - Even if the device is off, @a download_id is available for 48 hours if the user does not call download_destroy().
  34  * - Supports the callback that is called whenever the status of download changes.
  35  * - Even if the client process is terminated, download is going on.
  36  *   If you want to stop a download, download_cancel() or download_destroy() should be called.
  37  *
  38  * @section CAPI_WEB_DOWNLOAD_MODULE_FEATURE Related Features
  39  * This API is related with the following features:\n
  40  *  - http://tizen.org/feature/download\n
  41  *  - http://tizen.org/feature/network.telephony\n
  42  *  - http://tizen.org/feature/network.wifi\n
  43  *  - http://tizen.org/feature/network.wifi.direct\n
  44  *
  45  * It is recommended to design feature related codes in your application for reliability.\n
  46  *
  47  * You can check if a device supports the related features for this API by using @ref CAPI_SYSTEM_SYSTEM_INFO_MODULE, thereby controlling the procedure of your application.\n
  48  *
  49  * To ensure your application is only running on the device with specific features, please define the features in your manifest file using the manifest editor in the SDK.\n
  50  *
  51  * More details on featuring your application can be found from <a href="https://docs.tizen.org/application/tizen-studio/native-tools/manifest-text-editor#%3Cfeature%3E-element"><b>Feature Element</b>.</a>
  52  *
  53  */
  54
  55 #endif /* __TIZEN_WEB_DOWNLOAD_DOC_H__ */