include/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_WEB_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 download_id from download_create(), other APIs use download_id as parameter.
  33  * - Even if the device is off, download_id is available for 48 hours if user did't call download_destroy().
  34  * - support the callback that called whenever changed the status of download.
  35  * - Even if the client process is terminated, download is going on.
  36  *   If wanna stop a download, download_cancel() or download_destroy() should be called.
  37  *
  38  */
  39
  40 #endif /* __TIZEN_WEB_DOWNLOAD_DOC_H__ */