* @{
*/
+
/**
* @brief The package information handle.
* @since_tizen 2.3
*/
typedef struct package_info_s *package_info_h;
+
/**
* @brief Enumeration for storage type.
* @since_tizen 2.3
PACKAGE_INFO_EXTERNAL_STORAGE = 1, /**< External storage */
} package_info_installed_storage_type_e;
+
/**
* @brief Enumeration for app component type.
* @since_tizen 2.3
PACKAGE_INFO_SERVICEAPP = 2, /**< Service application */
} package_info_app_component_type_e;
+
/**
* @brief Enumeration for certification type.
* @since_tizen 2.3
PACKAGE_INFO_DISTRIBUTOR2_SIGNER_CERT = 8, /**< Distributor2 Signer Certificate*/
} package_cert_type_e;
+
/**
* @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] 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
- *
+ * @param[in] comp_type The Application Component type
+ * @param[in] callback The callback function to be invoked
+ * @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_app_from_package() will invoke this callback.
* @see package_info_foreach_app_from_package()
*/
typedef bool (*package_info_app_cb) (package_info_app_component_type_e comp_type, const char *app_id, void *user_data);
+
/**
* @brief Called to get the certification information.
* @since_tizen 2.3
- *
* @param[in] package_info 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.
* @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
- *
+ * @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_cert_info() will invoke this callback.
- *
* @see package_info_foreach_cert_info()
*/
typedef bool (*package_info_cert_info_cb) (package_info_h handle, package_cert_type_e cert_type, const char *cert_value, void *user_data);
+
/**
* @brief Called to get the privilege information.
* @since_tizen 2.3
- *
* @param[in] privilege_name the name of the privilege
* @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_privilege_info() will invoke this callback.
- *
* @see package_info_foreach_privilege_info()
*/
typedef bool (*package_info_privilege_info_cb) (const char *privilege_name, void *user_data);
+
/**
* @brief Retrieves all application IDs of each package.
* @since_tizen 2.3
- *
* @param[in] package_info The package info handle
* @param[in] comp_type The application component type
* @param[in] callback The callback function to invoke
* @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_NO_SUCH_PACKAGE No such package
- *
- * @post This function invokes package_info_app_cb() repeatedly for each package.
- *
+ * @post This function invokes package_info_app_cb() repeatedly for each package.
* @see package_info_app_cb()
*/
int package_info_foreach_app_from_package(package_info_h package_info, package_info_app_component_type_e comp_type, package_info_app_cb callback, void *user_data);
+
/**
* @brief Destroys the package information handle and releases all its resources.
* @since_tizen 2.3
- *
* @param[in] package_info The package information handle
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
* @retval #PACKAGE_MANAGER_ERROR_NONE Successful
* @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
- *
* @see package_manager_foreach_package_info()
* @see package_manager_get_package_info()
*/
int package_info_destroy(package_info_h package_info);
+
/**
* @brief Gets the package name.
* @since_tizen 2.3
- *
* @remarks You must release @a package using free().
- *
* @param[in] package_info The package information
* @param[out] package The package name
- *
* @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_OUT_OF_MEMORY Out of memory
*/
int package_info_get_package(package_info_h package_info, char **package);
+
/**
* @brief Gets the label of the package.
* @since_tizen 2.3
- *
* @remarks You must release @a label using free().
- *
* @param[in] package_info The package information
* @param[out] label The label of the package
- *
* @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_OUT_OF_MEMORY Out of memory
*/
int package_info_get_label(package_info_h package_info, char **label);
+
/**
* @brief Gets the absolute path to the icon image.
* @since_tizen 2.3
- *
* @remarks You must release @a path using free().
- *
* @param[in] package_info The package information
* @param[out] path The path of the package
- *
* @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_OUT_OF_MEMORY Out of memory
*/
int package_info_get_icon(package_info_h package_info, char **path);
+
/**
* @brief Gets the version of the package.
* @since_tizen 2.3
- *
* @remarks You must release @a version using free().
- *
* @param[in] package_info The package information
* @param[out] version The version of the package
- *
* @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_OUT_OF_MEMORY Out of memory
*/
int package_info_get_version(package_info_h package_info, char **version);
+
/**
* @brief Gets the type of the package.
* @since_tizen 2.3
- *
* @remarks You must release @a type using free().
- *
* @param[in] package_info The package information
* @param[out] type The type of the package
- *
* @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_OUT_OF_MEMORY Out of memory
*/
int package_info_get_type(package_info_h package_info, char **type);
+
/**
* @brief Gets the installed storage for the given package.
* @since_tizen 2.3
- *
* @param[in] package_info The package information
* @param[out] storage The installed storage
- *
- * @return @c 0 on success,
- * otherwise a negative error value
- *
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #PACKAGE_MANAGER_ERROR_NONE Successful
* @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
*/
int package_info_get_installed_storage(package_info_h package_info, package_info_installed_storage_type_e *storage);
+
/**
* @brief Gets the root path of the package.
* @since_tizen 2.3
- *
* @remarks You must release @a path using free().
- *
* @param[in] package_info The package information
* @param[out] path The root path of the package
- *
* @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_OUT_OF_MEMORY Out of memory
*/
int package_info_get_root_path(package_info_h package_info, char **path);
+
/**
* @platform
* @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
- * @remarks name must be released using free().
+ * @remarks Name must be released using free().
* @param[in] package_info The package information
* @param[out] name The name of the tep
- * @return 0 on success, otherwise a negative error value
+ * @return 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_OUT_OF_MEMORY Out of memory
*/
int package_info_get_tep_name(package_info_h package_info, char **name);
+
/**
* @brief Checks whether the package is system package.
* @since_tizen 2.3
- *
* @param[in] package_info The package information
* @param[out] system @c true if the package is system package,
* otherwise @c false if the package is not system package
- *
* @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_OUT_OF_MEMORY Out of memory
*/
int package_info_is_system_package(package_info_h package_info, bool *system);
+
/**
* @brief Checks whether the package is removable.
* @since_tizen 2.3
- *
* @param[in] package_info The package information
* @param[out] removable The removable info of the package
- *
* @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_OUT_OF_MEMORY Out of memory
*/
int package_info_is_removable_package(package_info_h package_info, bool *removable);
+
/**
* @brief Checks whether the package is preloaded.
* @since_tizen 2.3
- *
* @param[in] package_info The package information
* @param[out] preload The preload info of the package
- *
* @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_OUT_OF_MEMORY Out of memory
*/
int package_info_is_preload_package(package_info_h package_info, bool *preload);
+
/**
- * @brief Checks whether two package information are equal.
+ * @brief Checks whether two package information is equal.
* @since_tizen 2.3
- *
* @param[in] lhs The first package information to be compared
* @param[in] rhs The second package information to be compared
* @param[out] equal @c true if the package information are equal,
* otherwise @c false if package information are not equal
- *
* @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_OUT_OF_MEMORY Out of memory
*/
int package_info_is_equal(package_info_h lhs, package_info_h rhs, bool *equal);
+
/**
* @brief Checks whether the package info is accessible for the given package.
* @since_tizen 2.3
- *
* @param[in] package_info The package information
* @param[out] accessible @c true if the package info is accessible,
* otherwise @c false if the package info is not accessible
- *
- * @return @c 0 on success,
- * otherwise a negative error value
- *
+ * @return @c 0 on success,
+ * otherwise a negative error value
* @retval #PACKAGE_MANAGER_ERROR_NONE Successful
* @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
*/
int package_info_is_accessible(package_info_h package_info, bool *accessible);
+
/**
* @brief Clones the package information handle.
* @since_tizen 2.3
- *
* @param[out] clone The newly created package information handle
* @param[in] package_info The package information
- *
* @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_NO_SUCH_PACKAGE The package is not installed
*/
int package_info_clone(package_info_h *clone, package_info_h package_info);
+
/**
* @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
* @param[out] package_info The package information for the given package ID
- *
* @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_NO_SUCH_PACKAGE The package is not installed
*/
int package_info_create(const char *package, package_info_h *package_info);
+
/**
* @brief Retrieves certification information of the package.
* @since_tizen 2.3
- *
* @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_OUT_OF_MEMORY Out of memory
*/
int package_info_foreach_cert_info(package_info_h package_info, package_info_cert_info_cb callback, void *user_data);
+
/**
* @brief Retrieves privilege information of the package.
* @since_tizen 2.3
- *
* @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_OUT_OF_MEMORY Out of memory
*/
int package_info_foreach_privilege_info(package_info_h package_info, package_info_privilege_info_cb callback, void *user_data);
+
/**
* @}
*/
*/
/**
- * @brief Value to be used when filtering based on install location: Boolean property for filtering whether the package is removable or not based on package info
+ * @brief Definition for value to be used when filtering based on install location: Boolean property for filtering whether the package is removable or not based on package info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define PACKAGE_MANAGER_PKGINFO_PROP_REMOVABLE "PMINFO_PKGINFO_PROP_PACKAGE_REMOVABLE"
+
/**
- * @brief Value to be used when filtering based on install location: Boolean property for filtering whether the package is readonly or not based on package info
+ * @brief Definition for value to be used when filtering based on install location: Boolean property for filtering whether the package is readonly or not based on package info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define PACKAGE_MANAGER_PKGINFO_PROP_READONLY "PMINFO_PKGINFO_PROP_PACKAGE_READONLY"
+
/**
- * @brief Value to be used when filtering based on install location: Boolean property for filtering whether the package supports disable or not based on package info
+ * @brief Definiton for value to be used when filtering based on install location: Boolean property for filtering whether the package supports disable or not based on package info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define PACKAGE_MANAGER_PKGINFO_PROP_SUPPORT_DISABLE "PMINFO_PKGINFO_PROP_PACKAGE_SUPPORT_DISABLE"
+
/**
- * @brief Value to be used when filtering based on install location: Boolean property for filtering whether the package is disabled based on package info
+ * @brief Definition for value to be used when filtering based on install location: Boolean property for filtering whether the package is disabled based on package info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define PACKAGE_MANAGER_PKGINFO_PROP_DISABLE "PMINFO_PKGINFO_PROP_PACKAGE_DISABLE"
+
/**
- * @brief Value to be used when filtering based on install location: Boolean property for filtering whether the package is preload or not based on package info
+ * @brief Definition for value to be used when filtering based on install location: Boolean property for filtering whether the package is preload or not based on package info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define PACKAGE_MANAGER_PKGINFO_PROP_PRELOAD "PMINFO_PKGINFO_PROP_PACKAGE_PRELOAD"
+
/**
* @brief Enumeration for error code.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
PACKAGE_MANAGER_ERROR_PERMISSION_DENIED = TIZEN_ERROR_PERMISSION_DENIED /**< Permission denied */
} package_manager_error_e;
+
/**
* @brief Enumeration for event type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
PACAKGE_MANAGER_EVENT_TYPE_UPDATE,
} package_manager_event_type_e;
+
/**
* @brief Enumeration for event state.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
PACAKGE_MANAGER_EVENT_STATE_FAILED,
} package_manager_event_state_e;
+
/**
* @brief Enumeration for move type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
PACAKGE_MANAGER_REQUEST_MOVE_TO_EXTERNAL,
} package_manager_move_type_e;
+
/**
* @brief Enumeration for certification compare type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
PACAKGE_MANAGER_COMPARE_BOTH_NO_CERT,
} package_manager_compare_result_type_e;
+
/**
* @brief Enumeration for permission type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
PACKAGE_MANAGER_PERMISSION_PRIVILEGE, /**< Privilege permission */
} package_manager_permission_type_e;
+
/**
* @brief Enumeration for status type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
PACKAGE_MANAGER_STATUS_TYPE_GET_SIZE = 0x40, /**< Get size status */
} package_manager_status_type_e;
+
/**
* @brief The Package manager handle.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
typedef struct package_manager_s *package_manager_h;
+
/**
* @brief Package manager filter handle.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
typedef struct package_manager_filter_s *package_manager_filter_h;
+
/**
- * @brief Called when the package is installed, uninstalled or updated, and the progress of the request to the package manager changes.
+ * @brief Called when the package is installed, uninstalled, or updated, and the progress of the request to the package manager changes.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @param[in] type The type of the package to be installed, uninstalled or updated
- * @param[in] package The name of the package to be installed, uninstalled or updated
- * @param[in] event_type The type of the request to the package manager
+ * @param[in] type The type of the package to be installed, uninstalled, or updated
+ * @param[in] package The name of the package to be installed, uninstalled, or updated
+ * @param[in] event_type The type of the request to the package manager
* @param[in] event_state The current state of the request to the package manager
* @param[in] progress The progress for the request that is being processed by the package manager \n
- * The range of progress is from @c 0 to @c 100.
+ * The range of progress is from @c 0 to @c 100
* @param[in] error The error code when the package manager failed to process the request
* @param[in] user_data The user data passed from package_manager_set_event_cb()
- *
* @see package_manager_set_event_cb()
* @see package_manager_unset_event_cb()
*/
-typedef void (*package_manager_event_cb) (
- const char *type,
- const char *package,
- package_manager_event_type_e event_type,
- package_manager_event_state_e event_state,
- int progress,
- package_manager_error_e error,
- void *user_data);
+typedef void (*package_manager_event_cb) ( const char *type, const char *package, package_manager_event_type_e event_type, package_manager_event_state_e event_state, int progress, package_manager_error_e error, void *user_data);
+
/**
* @brief Creates a package manager handle.
* @privlevel public
* @privilege %http://tizen.org/privilege/packagemanager.info
* @remarks You must release @a manager using package_manager_destroy().
- *
* @param[out] manager The package manager handle that is newly created on success
- *
* @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_OUT_OF_MEMORY Out of memory
*/
int package_manager_create(package_manager_h *manager);
+
/**
* @brief Destroys the package manager handle.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
* @param[in] manager The package manager handle
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
* @retval #PACKAGE_MANAGER_ERROR_NONE Successful
* @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
- *
* @see package_manager_create()
*/
int package_manager_destroy(package_manager_h manager);
+
/**
- * @brief Sets the event status of the package when the package is installed, uninstalled or updated.
- * You can combine multiple status using OR operation which you want to listen.
+ * @brief Sets the event status of the package when the package is installed, uninstalled, or updated.
+ * @details You can combine multiple status using OR operation which you want to listen.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
* @param [in] manager The package manager handle
* @param [in] status_type The status of the package
- *
* @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_IO_ERROR Internal I/O error
- *
* @see package_manager_status_type_e
* @see package_manager_set_event_cb()
*/
int package_manager_set_event_status(package_manager_h manager, int status_type);
+
/**
- * @brief Registers a callback function to be invoked when the package is installed, uninstalled or updated.
+ * @brief Registers a callback function to be invoked when the package is installed, uninstalled, or updated.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/packagemanager.info
* @param[in] manager The package manager handle
* @param[in] callback The callback function to be registered
* @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_PERMISSION_DENIED Permission denied
* @post package_manager_event_cb() will be invoked.
- *
* @see package_manager_set_event_status()
* @see package_manager_event_cb()
* @see package_manager_unset_event_cb()
*/
-int package_manager_set_event_cb(package_manager_h manager,
- package_manager_event_cb callback,
- void *user_data);
+int package_manager_set_event_cb(package_manager_h manager, package_manager_event_cb callback, void *user_data);
+
/**
* @brief Unregisters the callback function.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
* @param[in] manager The package manager handle
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
* @retval #PACKAGE_MANAGER_ERROR_NONE Successful
* @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
- *
* @see package_manager_event_cb()
* @see package_manager_set_event_cb()
*/
int package_manager_unset_event_cb(package_manager_h manager);
+
/**
* @brief Called to retrieve all packages.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
* @param[in] package_info The package information
* @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
- *
* @see package_manager_foreach_package_info()
*/
-typedef bool (*package_manager_package_info_cb) (
- package_info_h package_info,
- void *user_data);
+typedef bool (*package_manager_package_info_cb) ( package_info_h package_info, void *user_data);
+
/**
* @brief Retrieves all package information of installed packages.
* @privilege %http://tizen.org/privilege/packagemanager.info
* @param[in] callback The callback function to be invoked
* @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_PERMISSION_DENIED Permission denied
* @post This function invokes package_manager_package_info_cb() repeatedly for each package information.
- *
* @see package_manager_package_info_cb()
*/
-int package_manager_foreach_package_info(package_manager_package_info_cb callback,
- void *user_data);
+int package_manager_foreach_package_info(package_manager_package_info_cb callback, void *user_data);
+
/**
* @brief Gets the package ID for the given app ID.
* @privilege %http://tizen.org/privilege/packagemanager.info
* @param[in] app_id The ID of the application
* @param[out] package_id The ID of the package
- *
* @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_OUT_OF_MEMORY Out of memory
*/
int package_manager_get_package_id_by_app_id(const char *app_id, char **package_id);
+
/**
* @brief Gets the package information for the given package.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/packagemanager.info
* @remarks You must release @a package_info using package_info_destroy().
- *
* @param[in] package_id The ID of the package
* @param[out] package_info The package information for the given package ID
- *
* @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_OUT_OF_MEMORY Out of memory
/**
* @brief Compares whether two package certifications are matched.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
* @param[in] lhs_package_id The first package ID to compare
* @param[in] rhs_package_id The second package ID to compare
* @param[out] compare_result @c 0 if the certification information are matched,
* otherwise the compared result
- *
* @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_OUT_OF_MEMORY Out of memory
*/
int package_manager_compare_package_cert_info(const char *lhs_package_id, const char *rhs_package_id, package_manager_compare_result_type_e *compare_result);
+
/**
* @brief Compares whether two app certifications are matched.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
* @param[in] lhs_app_id The first app ID to compare
* @param[in] rhs_app_id The second app ID to compare
* @param[out] compare_result @c 0 if the certification information are matched,
* otherwise the compared result
- *
* @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_OUT_OF_MEMORY Out of memory
*/
int package_manager_compare_app_cert_info(const char *lhs_app_id, const char *rhs_app_id, package_manager_compare_result_type_e *compare_result);
+
/**
* @brief Checks whether the package is preloaded by @a app_id.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privilege %http://tizen.org/privilege/packagemanager.info
* @param[in] app_id The ID of the application
* @param[out] preload The preload info of the package
- *
* @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_OUT_OF_MEMORY Out of memory
*/
int package_manager_is_preload_package_by_app_id(const char *app_id, bool *preload);
+
/**
* @brief Gets the package permission type by @a app_id.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privilege %http://tizen.org/privilege/packagemanager.info
* @param[in] app_id The ID of the application
* @param[out] permission_type The package permission type
- *
* @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_OUT_OF_MEMORY Out of memory
*/
int package_manager_get_permission_type(const char *app_id, package_manager_permission_type_e *permission_type);
+
/**
- * @brief Clears the application's internal and external cache directory.
- * @details All files stored in the cache directory of the application specified with the
- * package ID are removed.
- *
+ * @brief Clears the application's internal and external cache directory.
+ * @details All files stored in the cache directory of the application specified with the package ID are removed.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/packagemanager.clearcache
- *
* @param[in] package_id The package ID
- *
* @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_NO_SUCH_PACKAGE No such package
* @platform
* @brief Clears all applications' internal and external cache directory.
* @details All files stored in the cache directory of each application are removed.
- *
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/packagemanager.admin
- *
* @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_NO_SUCH_PACKAGE No such package
*/
int package_manager_clear_all_cache_dir(void);
+
/**
- * @brief The handle for the package size information.
+ * @brief The package size information handle.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
*/
typedef struct package_size_info *package_size_info_h;
+
/**
- * @brief Called when the package size information is obtained.
+ * @brief Called when the package size information is obtained.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- *
- * @param[in] package_id The package ID
- * @param[in] size_info The pointer to the structure including the package size information
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] package_id The package ID
+ * @param[in] size_info The pointer to the structure including the package size information
+ * @param[in] user_data The user data to be passed to the callback function
*/
typedef void (*package_manager_size_info_receive_cb)(const char *package_id, const package_size_info_h size_info, void *user_data);
+
/**
* @platform
- * @brief Called when the total package size information is obtained.
+ * @brief Called when the total package size information is obtained.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @param[in] size_info The pointer to the structure including the package size information
- * @param[in] user_data The user data to be passed to the callback function
+ * @param[in] size_info The pointer to the structure including the package size information
+ * @param[in] user_data The user data to be passed to the callback function
*/
typedef void (*package_manager_total_size_info_receive_cb)(const package_size_info_h size_info, void *user_data);
+
/**
- * @brief Gets the package size information.
+ * @brief Gets the package size information.
* @details The package size info is asynchronously obtained by the callback function.
+ * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/packagemanager.info
- *
- * @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- *
- * @param[in] package_id The package ID
- * @param[in] callback The asynchronous callback function to get the package size information
- * @param[in] user_data The user data to be passed to the callback function
- *
+ * @param[in] package_id The package ID
+ * @param[in] callback The asynchronous callback function to get the package size information
+ * @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_NO_SUCH_PACKAGE No such package
*/
int package_manager_get_package_size_info(const char *package_id, package_manager_size_info_receive_cb callback, void *user_data);
+
/**
* @platform
- * @brief Gets the total package size information.
+ * @brief Gets the total package size information.
* @details The total package size info is asynchronously obtained by the callback function.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/packagemanager.info
- *
- * @param [in] callback The asynchronous callback function to get the total package size information
- * @param [in] user_data The user data to be passed to the callback function
- *
+ * @param[in] callback The asynchronous callback function to get the total package size information
+ * @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_NO_SUCH_PACKAGE No such package
*/
int package_manager_get_total_package_size_info(package_manager_total_size_info_receive_cb callback, void *user_data);
+
/**
* @brief Creates the package information filter handle from db.
* @details All filter properties will be ANDed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/packagemanager.info
- *
- * @param[out] handle Pointer to the package info filter handle.
- *
+ * @param[out] handle Pointer to the package info filter handle
* @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_IO_ERROR I/O error
*/
int package_manager_filter_create(package_manager_filter_h *handle);
+
/**
* @brief This API destroys the package information filter handle freeing up all the resources
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @param[in] handle Pointer to the package info filter handle.
- *
+ * @param[in] handle Pointer to the package info filter handle
* @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_IO_ERROR I/O error
*/
int package_manager_filter_destroy(package_manager_filter_h handle);
+
/**
* @brief This API adds a boolean filter property to the filter handle
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
- * @param[in] handle Pointer to the package info filter handle.
- * @param[in] property boolean property name.
- * @param[in] value value corresponding to the property.
- *
+ * @param[in] handle Pointer to the package info filter handle
+ * @param[in] property boolean property name
+ * @param[in] value value corresponding to the property
* @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_IO_ERROR I/O error
* @see package_manager_filter_count()
* @see package_manager_filter_foreach_package_info()
*/
-int package_manager_filter_add_bool(package_manager_filter_h handle,
- const char *property, const bool value);
+int package_manager_filter_add_bool(package_manager_filter_h handle, const char *property, const bool value);
+
/**
* @brief This API counts the package that satisfy the filter conditions
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/packagemanager.info
- *
- * @param[in] handle Pointer to the package info filter handle.
- * @param[out] count Pointer to store the count value.
- *
+ * @param[in] handle Pointer to the package info filter handle
+ * @param[out] count Pointer to store the count value
* @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_IO_ERROR I/O error
*/
int package_manager_filter_count(package_manager_filter_h handle, int *count);
+
/**
* @brief This API executes the user supplied callback function for each package that satisfy the filter conditions
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/packagemanager.info
- *
- * @param[in] handle Pointer to the package info filter handle.
- * @param[in] callback callback function.
+ * @param[in] handle Pointer to the package info filter handle
+ * @param[in] callback callback function
* @param[in] user_data 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_IO_ERROR I/O error
* @see package_manager_package_info_cb()
* @see package_manager_filter_count()
*/
-int package_manager_filter_foreach_package_info(package_manager_filter_h handle,
- package_manager_package_info_cb callback, void *user_data);
+int package_manager_filter_foreach_package_info(package_manager_filter_h handle, package_manager_package_info_cb callback, void *user_data);
+
/**
* @platform
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @privlevel platform
* @privilege %http://tizen.org/privilege/packagemanager.admin
+ * @remarks You must release @a req_data and @a license_url by yourself.
* @param[in] resp_data The response data string of the purchase request
* @param[out] req_data License request data
- * @param[out] license_url License acquisition url data
- * @remarks You must release @a req_data and @a license_url by yourself.
- * @return 0 on success, otherwise a negative error value
+ * @param[out] license_url License acquisition url data
+ * @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_OUT_OF_MEMORY Out of memory
*/
int package_manager_drm_generate_license_request(const char *resp_data, char **req_data, char **license_url);
+
/**
* @platform
* @brief Registers encrypted license
* @privlevel platform
* @privilege %http://tizen.org/privilege/packagemanager.admin
* @param[in] resp_data The response data string of the rights request
- * @return 0 on success, otherwise a negative error value
+ * @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_IO_ERROR Internal I/O error
* @privilege %http://tizen.org/privilege/packagemanager.admin
* @param[in] drm_file_path DRM file path
* @param[in] decrypted_file_path Decrypted file path
- * @return 0 on success, otherwise a negative error value
+ * @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_IO_ERROR Internal I/O error
*/
int package_manager_drm_decrypt_package(const char *drm_file_path, const char *decrypted_file_path);
+
/**
- * @brief Retrieves data size from given handle
- *
+ * @brief Retrieves data size from given handle
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- *
- * @param[in] handle Package size info handle
- * @param[out] data_size Data size will be returned
- *
+ * @param[in] handle Package size info handle
+ * @param[out] data_size Data size will be returned
* @return @c 0 on success,
* otherwise a negative error value
- *
* @retval #PACKAGE_MANAGER_ERROR_NONE Successful
* @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
*/
int package_size_info_get_data_size(package_size_info_h handle, long long *data_size);
+
/**
- * @brief Retrieves cache size from given handle
- *
+ * @brief Retrieves cache size from given handle
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- *
* @param[in] handle Package size info handle
- * @param[out] cache_size Cache size will be returned
- *
+ * @param[out] cache_size Cache size will be returned
* @return @c 0 on success,
* otherwise a negative error value
- *
* @retval #PACKAGE_MANAGER_ERROR_NONE Successful
* @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
*/
int package_size_info_get_cache_size(package_size_info_h handle, long long *cache_size);
+
/**
- * @brief Retrieves application size from given handle
- *
+ * @brief Retrieves application size from given handle
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- *
- * @param[in] handle Package size info handle
- * @param[out] app_size App size will be returned
- *
+ * @param[in] handle Package size info handle
+ * @param[out] app_size App size will be returned
* @return @c 0 on success,
* otherwise a negative error value
- *
* @retval #PACKAGE_MANAGER_ERROR_NONE Successful
* @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
*/
int package_size_info_get_app_size(package_size_info_h handle, long long *app_size);
+
/**
- * @brief Retrieves external data size from given handle
- *
+ * @brief Retrieves external data size from given handle
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- *
* @param[in] handle Package size info handle
- * @param[out] ext_data_size External data size will be returned
- *
+ * @param[out] ext_data_size External data size will be returned
* @return @c 0 on success,
* otherwise a negative error value
- *
* @retval #PACKAGE_MANAGER_ERROR_NONE Successful
* @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
*/
/**
- * @brief Retrieves external cache size from given handle
- *
+ * @brief Retrieves external cache size from given handle
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- *
- * @param[in] handle Package size info handle
- * @param[out] ext_cache_size External cache size will be returned
- *
+ * @param[in] handle Package size info handle
+ * @param[out] ext_cache_size External cache size will be returned
* @return @c 0 on success,
* otherwise a negative error value
- *
* @retval #PACKAGE_MANAGER_ERROR_NONE Successful
* @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
*/
/**
- * @brief Retrieves external application size from given handle
- *
+ * @brief Retrieves external application size from given handle
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
- *
- * @param[in] handle Package size info handle
- * @param[out] ext_app_size External app size will be returned
- *
+ * @param[in] handle Package size info handle
+ * @param[out] ext_app_size External app size will be returned
* @return @c 0 on success,
* otherwise a negative error value
- *
* @retval #PACKAGE_MANAGER_ERROR_NONE Successful
* @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
*/
int package_size_info_get_external_app_size(package_size_info_h handle, long long *ext_app_size);
+
/**
* @}
*/
* @{
*/
+
/**
* @platform
* @brief Enumeration for request mode.
PACAKGE_MANAGER_REQUEST_MODE_QUIET,
} package_manager_request_mode_e;
+
/**
* @platform
* @brief The Package manager request handle.
*/
typedef struct package_manager_request_s *package_manager_request_h;
+
/**
* @platform
* @brief Called when the progress of the request to the package manager changes.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
* @param[in] id The ID of the request to the package manager
* @param[in] type The type of the package to install, uninstall or update
* @param[in] package The name of the package to install, uninstall or update
* The range of progress is from @c 0 to @c 100.
* @param[in] error The error code when the package manager failed to process the request
* @param[in] user_data The user data passed from package_manager_request_set_event_cb()
- *
* @see package_manager_request_set_event_cb()
* @see package_manager_request_unset_event_cb()
*/
-typedef void (*package_manager_request_event_cb) (
- int id,
- const char *type,
- const char *package,
- package_manager_event_type_e event_type,
- package_manager_event_state_e event_state,
- int progress,
- package_manager_error_e error,
- void *user_data);
+typedef void (*package_manager_request_event_cb) ( int id, const char *type, const char *package, package_manager_event_type_e event_type, package_manager_event_state_e event_state, int progress, package_manager_error_e error, void *user_data);
+
/**
* @platform
* @brief Creates a request handle to the package manager.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
* @remarks You must release @a request using package_manager_request_destroy().
- *
* @param[out] request The request handle that is newly created on success
- *
* @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_OUT_OF_MEMORY Out of memory
* @retval #PACKAGE_MANAGER_ERROR_IO_ERROR Internal I/O error
- *
* @see package_manager_request_destroy()
*/
int package_manager_request_create(package_manager_request_h *request);
+
/**
* @platform
* @brief Destroys the request handle to the package manager.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
* @param[in] request The request handle to the package manager
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
* @retval #PACKAGE_MANAGER_ERROR_NONE Successful
* @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
- *
* @see package_manager_request_create()
*/
int package_manager_request_destroy(package_manager_request_h request);
+
/**
* @platform
* @brief Registers a callback function to be invoked when the progress of the request changes.
* @param[in] request The request handle
* @param[in] callback The callback function to be registered
* @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_PERMISSION_DENIED Permission denied
* @post package_manager_request_event_cb() will be invoked.
- *
* @see package_manager_request_event_cb()
* @see package_manager_request_unset_event_cb()
*/
-int package_manager_request_set_event_cb(package_manager_request_h request,
- package_manager_request_event_cb callback, void *user_data);
+int package_manager_request_set_event_cb(package_manager_request_h request, package_manager_request_event_cb callback, void *user_data);
+
/**
* @platform
* @brief Unregisters the callback function.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
* @param[in] request The request handle
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
* @retval #PACKAGE_MANAGER_ERROR_NONE Successful
* @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
- *
* @see package_manager_request_event_cb()
* @see package_manager_request_set_event_cb()
*/
int package_manager_request_unset_event_cb(package_manager_request_h request);
+
/**
* @platform
- * @brief Sets the type of the package to install, uninstall or update.
+ * @brief Sets the type of the package to install, uninstall, or update.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
* @param[in] request The request handle
* @param[in] type The type of the package
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
* @retval #PACKAGE_MANAGER_ERROR_NONE Successful
* @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
*/
-int package_manager_request_set_type(package_manager_request_h request,
- const char *type);
+int package_manager_request_set_type(package_manager_request_h request, const char *type);
+
/**
* @platform
* @brief Sets the mode of the request.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- *
* @param[in] request The request handle
* @param[in] mode The mode of the request
- *
* @return @c 0 on success,
* otherwise a negative error value
- *
* @retval #PACKAGE_MANAGER_ERROR_NONE Successful
* @retval #PACKAGE_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
*/
-int package_manager_request_set_mode(package_manager_request_h request,
- package_manager_request_mode_e mode);
+int package_manager_request_set_mode(package_manager_request_h request, package_manager_request_mode_e mode);
+
/**
* @platform
* @privlevel platform
* @privilege %http://tizen.org/privilege/packagemanager.admin
* @param[in] request The request handle
- * @param[in] tep_path The tep path to set. If this is NULL on update, installed tep will be removed.
- * @return 0 on success, otherwise a negative error value
+ * @param[in] tep_path The TEP path to set. If this is NULL on update, installed TEP will be removed.
+ * @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_PERMISSION_DENIED Permission denied
* @retval #PACKAGE_MANAGER_ERROR_SYSTEM_ERROR Severe system error
*/
-int package_manager_request_set_tep(package_manager_request_h request,
- const char *tep_path);
+int package_manager_request_set_tep(package_manager_request_h request, const char *tep_path);
+
/**
* @platform
* @param[in] request The request handle
* @param[in] path The absolute path to the package to be installed
* @param[out] id The ID of the request to the package manager
- *
* @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_PERMISSION_DENIED Permission denied
* @see package_manager_request_uninstall()
*/
-int package_manager_request_install(package_manager_request_h request,
- const char *path, int *id);
+int package_manager_request_install(package_manager_request_h request, const char *path, int *id);
+
/**
* @platform
* @param[in] request The request handle
* @param[in] name The name of the package to be uninstalled
* @param[out] id The ID of the request to the package manager
- *
* @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_PERMISSION_DENIED Permission denied
*/
-int package_manager_request_uninstall(package_manager_request_h request,
- const char *name, int *id);
+int package_manager_request_uninstall(package_manager_request_h request, const char *name, int *id);
+
/**
* @platform
* @param[in] request The request handle
* @param[in] name The name of the package to be moved
* @param[in] move_type The move type [enum package_manager_move_type_e], [external to internal/internal to external]
- *
* @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_PERMISSION_DENIED Permission denied
*/
-int package_manager_request_move(package_manager_request_h request,
- const char *name, package_manager_move_type_e move_type);
+int package_manager_request_move(package_manager_request_h request, const char *name, package_manager_move_type_e move_type);
+
/**
* @}
projects / platform / core / api / package-manager.git / commitdiff