doc/package_manager_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
  18 #ifndef __TIZEN_PACKAGE_MANAGER_DOC_H__
  19 #define __TIZEN_PACKAGE_MANAGER_DOC_H__
  20
  21
  22 /**
  23  * @ingroup CAPI_APPLICATION_FRAMEWORK
  24  * @defgroup CAPI_PACKAGE_MANAGER_MODULE Package Manager
  25  * @brief The package manager is one of the core modules of Tizen application framework, and responsible for getting their information.
  26  *        You can also retrieve information related to the packages that are installed on the device.
  27  * @section CAPI_PACKAGE_MANAGER_MODULE_HEADER Required Header
  28  *   \#include <package_manager.h>
  29  *
  30  * @section CAPI_PACKAGE_MANAGER_MODULE_OVERVIEW Overview
  31  * The Package Manager API provides functions to retrieve information related to the packages and also provides event listening function.
  32  * You can get the status of package using package_manager_set_event_status() and package_manager_set_event_cb().
  33  * If you register package_manager_event_cb(), it is invoked when a package is installed, uninstalled, or updated.
  34  */
  35
  36
  37 /**
  38  * @ingroup CAPI_PACKAGE_MANAGER_MODULE
  39  * @defgroup CAPI_PACKAGE_INFO_MODULE Package Information
  40  * @brief Packager Manager information API for packaging. It provides functions for getting the package information.
  41  * @section CAPI_PACKAGE_INFO_MODULE_HEADER Required Header
  42  *   \#include <package_manager.h>
  43  *
  44  * @section CAPI_PACKAGE_INFO_MODULE_OVERVIEW Overview
  45  * The package manager is used to retrieve detailed information of the installed packages on the device.
  46  * This information includes package name, label, path to the icon image, version, type, and installed storage.
  47  * To retrieve package information, you should get the #package_info_h using package_info_create() or package_manager_get_package_info().
  48  * The package_manager_foreach_package_info() is used to retrieve all the package information of installed packages.
  49  * And then package_manager_package_info_cb() is invoked. When the callback function is called, you can get the information using the following functions.
  50  */
  51
  52
  53 /**
  54  * @ingroup CAPI_PACKAGE_MANAGER_MODULE
  55  * @defgroup CAPI_PACKAGE_REQUEST_MODULE Package Manager Request
  56  * @brief Package Manager Request API. It is responsible for installing, uninstalling, moving packages, and storing their information.
  57  * @section CAPI_PACKAGE_REQUEST_MODULE_HEADER Required Header
  58  *   \#include <package_manager.h>
  59  *
  60  * @section CAPI_PACKAGE_REQUEST_MODULE_OVERVIEW Overview
  61  * The Package Manager API provides functions to install and uninstall the package, and also provides event listening function.
  62  * The package_manager_request_install() method is used to asynchronously install a package.
  63  * Similarly, the package_manager_request_uninstall() and package_manager_request_move() methods are used to
  64  * asynchronously uninstall a package. The callback function is called when the progress of the request changes.
  65  * Use package_manager_request_event_cb() to listen to package installation related events.
  66  */
  67
  68
  69 /**
  70  * @ingroup CAPI_PACKAGE_MANAGER_MODULE
  71  * @defgroup CAPI_PACKAGE_ARCHIVE_INFO_MODULE Package Archive Info
  72  * @brief Package Archive Info API. It provides functions for getting information of the package archive.
  73  * @section CAPI_PACKAGE_ARCHIVE_INFO_MODULE_HEADER Required Header
  74  *   \#include <package_archive_info.h>
  75  *
  76  * @section CAPI_PACKAGE_ARCHIVE_INFO_MODULE_OVERVIEW Overview
  77  * The Package Archive Info API provides functions to get information from the package archive.
  78  * You can get basic information such as package id, description, label, author and so on.
  79  * Also you can get raw data of icon of the package archive.
  80  */
  81
  82
  83 #endif /* __TIZEN_PACKAGE_MANAGER_DOC_H__ */