Fix passing wrong event_type when error signal received

[platform/core/api/package-manager.git] / include / package_info.h

diff --git a/include/package_info.h b/include/package_info.h
index 9b0145b..414ff5e 100644 (file)
--- a/include/package_info.h
+++ b/include/package_info.h
@@ -112,8 +112,8 @@ typedef bool (*package_info_updateinfo_cb) (package_updateinfo_h info, void *use
 /**
  * @brief Called to get the application ID once for each installed package.
  * @since_tizen 2.3
- * @param[in] comp_type The Application Component type
- * @param[in] callback  The callback function to be invoked
+ * @param[in] comp_type The application component type
+ * @param[in] app_id    The application ID.
  * @param[in] user_data The user data passed from the foreach function
  * @return @c true to continue with the next iteration of the loop,
  *         otherwise @c false to break out of the loop
@@ -126,7 +126,7 @@ typedef bool (*package_info_app_cb) (package_info_app_component_type_e comp_type
 /**
  * @brief Called to get the certification information.
  * @since_tizen 2.3
- * @param[in] package_info The package info handle
+ * @param[in] handle       The package info handle
  * @param[in] cert_type    The certificate type
  * @param[in] cert_value   The certificate value of corresponding certificate key \n
  *                         This value is base64 encoded data.
@@ -153,6 +153,25 @@ typedef bool (*package_info_privilege_info_cb) (const char *privilege_name, void
 
 
 /**
+ * @brief Called to provide dependency information.
+ * @since_tizen 5.5
+ * @remarks @a from, @a to, @a type and @a required_version are managed by the platform and will be released after the callback exits.
+ * @param[in] from             The ID of package which depends other package
+ * @param[in] to               The ID of package which depended by other package
+ * @param[in] type             The type of dependency
+ * @param[in] required_version The required version
+ * @param[in] user_data        The user data passed from the foreach function
+ * @return  @c true to continue with the next iteration of the loop,
+ *          otherwise @c false to break out of the loop
+ * @pre package_info_foreach_dependency_info() will invoke this callback.
+ * @pre package_info_foreach_dependency_info_depends_on() will invoke this callback.
+ * @see package_info_foreach_dependency_info()
+ * @see package_info_foreach_dependency_info_depends_on()
+ */
+typedef bool (*package_info_dependency_info_cb) (const char *from, const char *to, const char *type, const char *required_version, void *user_data);
+
+
+/**
  * @brief Retrieves all application IDs of each package.
  * @since_tizen 2.3
  * @param[in] package_info  The package info handle
@@ -310,7 +329,7 @@ int package_info_get_root_path(package_info_h package_info, char **path);
 
 /**
  * @platform
- * @brief Gets the name of the TEP(Tizen Expansion Package).
+ * @brief Gets the name of the TEP (Tizen Expansion Package).
  * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
  * @privlevel platform
  * @privilege %http://tizen.org/privilege/packagemanager.admin
@@ -434,7 +453,7 @@ int package_info_get_installed_time(package_info_h package_info, int *installed_
 int package_info_clone(package_info_h *clone, package_info_h package_info);
 
 /**
- * @brief Gets the package information for the given package
+ * @brief Gets the package information for the given package.
  * @since_tizen 2.3
  * @remarks You must release @a package_info using package_info_destroy().
  * @param[in]  package      The ID of the package
@@ -481,6 +500,54 @@ int package_info_foreach_cert_info(package_info_h package_info, package_info_cer
 int package_info_foreach_privilege_info(package_info_h package_info, package_info_privilege_info_cb callback, void *user_data);
 
 /**
+ * @brief Retrieves dependency information of the package.
+ * @details The results include packages that are only directly required by a given package.
+ *          For example, if we have:
+ *
+ *                B --> E
+ *          A --> B --> C
+ *                D --> C
+ *
+ *          where A --> B means that A depends on B, and package_info_foreach_dependency_info(A) is called,
+ *          the results will be: {from A to B}.
+ * @since_tizen 5.5
+ * @remarks The function provides the results synchronously. If there are no dependencies, this function will return PACKAGE_MANAGER_ERROR_NONE immediately and the callback will not be invoked.
+ * @param[in] package_info The package information
+ * @param[in] callback     The iteration callback function
+ * @param[in] user_data    The user data to be passed to the callback function
+ * @return @c 0 on success,
+ *         otherwise a negative error value
+ * @retval #PACKAGE_MANAGER_ERROR_NONE              Successful
+ * @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #PACKAGE_MANAGER_ERROR_SYSTEM_ERROR      Severe system error
+ */
+int package_info_foreach_dependency_info(package_info_h package_info, package_info_dependency_info_cb callback, void *user_data);
+
+/**
+ * @brief Retrieves information about which packages depend on a given package.
+ * @details The results include packages that both directly and indirectly depend on a given package.
+ *          For example, if we have:
+ *
+ *                B --> E
+ *          A --> B --> C
+ *                D --> C
+ *
+ *          where A --> B means that A depends on B, and package_info_foreach_dependency_info_depends_on(C) is called,
+ *          the results will be: {from B to C}, {from D to C}, {from A to B}.
+ * @since_tizen 5.5
+ * @remarks The function provides the results synchronously. If there are no dependencies, this function will return PACKAGE_MANAGER_ERROR_NONE immediately and the callback will not be invoked.
+ * @param[in] package_info The package information
+ * @param[in] callback     The iteration callback function
+ * @param[in] user_data    The user data to be passed to the callback function
+ * @return @c 0 on success,
+ *         otherwise a negative error value
+ * @retval #PACKAGE_MANAGER_ERROR_NONE              Successful
+ * @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #PACKAGE_MANAGER_ERROR_SYSTEM_ERROR      Severe system error
+ */
+int package_info_foreach_dependency_info_depends_on(package_info_h package_info, package_info_dependency_info_cb callback, void *user_data);
+
+/**
  * @brief Gets the package update information for the given package.
  * @since_tizen 4.0
  * @remarks You must release @a info using package_info_updateinfo_destroy().
@@ -508,7 +575,7 @@ int package_info_updateinfo_create(const char *pkgid, package_updateinfo_h *info
  * @retval #PACKAGE_MANAGER_ERROR_NONE              Successful
  * @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #PACKAGE_MANAGER_ERROR_OUT_OF_MEMORY     Out of memory
- * @retval #PACKAGE_MANAGER_ERROR_IO_ERROR          Internal I/O error occured
+ * @retval #PACKAGE_MANAGER_ERROR_IO_ERROR          Internal I/O error occurred
  */
 int package_info_updateinfo_get_pkgid(package_updateinfo_h info, char **package);
 
@@ -523,7 +590,7 @@ int package_info_updateinfo_get_pkgid(package_updateinfo_h info, char **package)
  * @retval #PACKAGE_MANAGER_ERROR_NONE              Successful
  * @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
  * @retval #PACKAGE_MANAGER_ERROR_OUT_OF_MEMORY     Out of memory
- * @retval #PACKAGE_MANAGER_ERROR_IO_ERROR          Internal I/O error occured
+ * @retval #PACKAGE_MANAGER_ERROR_IO_ERROR          Internal I/O error occurred
  */
 int package_info_updateinfo_get_version(package_updateinfo_h info, char **version);
 
@@ -536,7 +603,7 @@ int package_info_updateinfo_get_version(package_updateinfo_h info, char **versio
  *         otherwise a negative error value
  * @retval #PACKAGE_MANAGER_ERROR_NONE              Successful
  * @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #PACKAGE_MANAGER_ERROR_IO_ERROR          Internal I/O error occured
+ * @retval #PACKAGE_MANAGER_ERROR_IO_ERROR          Internal I/O error occurred
  */
 int package_info_updateinfo_get_type(package_updateinfo_h info,
                                                package_updateinfo_type_e *type);
@@ -554,7 +621,7 @@ int package_info_updateinfo_get_type(package_updateinfo_h info,
 int package_info_updateinfo_destroy(package_updateinfo_h info);
 
 /**
- * @brief Retrieve update information of all packages and invoke callback for each of it.
+ * @brief Retrieves update information of all packages and invoke callback for each of it.
  * @since_tizen 4.0
  * @param[in] callback     The iteration callback function
  * @param[in] user_data    The user data to be passed to the callback function