Update doxygen
[platform/core/api/package-manager.git] / include / package_manager_extension.h
1 /*
2  * Copyright (c) 2017 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_APPFW_PACKAGE_MANAGER_EXTENSION_H
18 #define __TIZEN_APPFW_PACKAGE_MANAGER_EXTENSION_H
19
20 #include "package_manager.h"
21
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25
26 /**
27  * @file package_manager_extension.h
28  */
29
30 /**
31  * @addtogroup CAPI_PACKAGE_MANAGER_MODULE
32  * @{
33  */
34
35 /**
36  * @platform
37  * @brief Installs the package located at the given path as the runtime mountable package, asynchronously.
38  * @since_tizen 4.0
39  * @privlevel platform
40  * @privilege %http://tizen.org/privilege/packagemanager.admin
41  * @param[in]  request The request handle
42  * @param[in]  path    The absolute path to the package to be installed
43  * @param[out] id      The ID of the request to the package manager
44  * @return @c 0 on success,
45  *         otherwise a negative error value
46  * @retval #PACKAGE_MANAGER_ERROR_NONE              Successful
47  * @retval #PACKAGE_MANAGER_ERROR_PERMISSION_DENIED Permission denied
48  * @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
49  * @see package_manager_request_uninstall()
50  */
51 int package_manager_request_mount_install(package_manager_request_h request, const char *path, int *id);
52
53
54 /**
55  * @platform
56  * @brief Installs the package located at the given path as the runtime mountable package, asynchronously.
57  * @details The progress of the request is asynchronously received by the callback function.
58  *          The @a callback is the individual callback only called for the current API call.
59  *          The @a callback is the only callback called, even if another callback was set for this request
60  *          with package_manager_request_set_event_cb().
61  * @since_tizen 4.0
62  * @privlevel platform
63  * @privilege %http://tizen.org/privilege/packagemanager.admin
64  * @param[in]  request   The request handle
65  * @param[in]  path      The absolute path to the package to be installed
66  * @param[in]  callback  The callback function to be invoked
67  * @param[in]  user_data The user data to be passed to the callback function
68  * @param[out] id        The ID of the request to the package manager
69  * @return @c 0 on success,
70  *         otherwise a negative error value
71  * @retval #PACKAGE_MANAGER_ERROR_NONE              Successful
72  * @retval #PACKAGE_MANAGER_ERROR_PERMISSION_DENIED Permission denied
73  * @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
74  */
75 int package_manager_request_mount_install_with_cb(package_manager_request_h request,
76                                                 const char *path,
77                                                 package_manager_request_event_cb callback,
78                                                 void *user_data,
79                                                 int *id);
80
81 /**
82 * @}
83 */
84
85 #ifdef __cplusplus
86 }
87 #endif
88
89 #endif /* __TIZEN_APPFW_PACKAGE_MANAGER_EXTENSION_H */