/**
- * @brief Enumeration for the application state
+ * @brief Enumeration for the application state.
* @since_tizen 3.0
*/
typedef enum {
* @brief Gets the application state with the given application context.
* @since_tizen 3.0
* @remarks Note that application's state might be changed after you get app_context.
- * This API just returns the state of application when you get the app_context.
+ * This function just returns the state of application when you get the app_context.
* @param[in] app_context The application context
* @param[out] state The application state of the given application context
* @return @c 0 on success,
/**
* @brief Clones the application context handle.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @remarks The @a clone should be released using app_context_destroy()
* @param[out] clone The newly created application context handle, if cloning is successful
* @param[in] app_context The application context
* @return @c 0 on success,
*/
/**
- * @brief Definition for string property for filtering based on app info: String property for filtering packages with app id
+ * @brief Definition for string property for filtering based on app info: String property for filtering packages with app id.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define PACKAGE_INFO_PROP_APP_ID "PACKAGE_INFO_PROP_APP_ID"
/**
- * @brief Definition for string property for filtering based on app info: String property for filtering packages with app type
+ * @brief Definition for string property for filtering based on app info: String property for filtering packages with app type.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define PACKAGE_INFO_PROP_APP_TYPE "PACKAGE_INFO_PROP_APP_TYPE"
/**
- * @brief Definition for string property for filtering based on app info: String property for filtering packages with app category
+ * @brief Definition for string property for filtering based on app info: String property for filtering packages with app category.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define PACKAGE_INFO_PROP_APP_CATEGORY "PACKAGE_INFO_PROP_APP_CATEGORY"
/**
- * @brief Definition for string property for filtering based on app info: String property for filtering packages with installed storage of app
- * Value related with this property should be "installed_internal" or "installed_external"
+ * @brief Definition for string property for filtering based on app info: String property for filtering packages with installed storage of app.
+ * Value related with this property should be "installed_internal" or "installed_external".
* @since_tizen 3.0
*/
#define PACKAGE_INFO_PROP_APP_INSTALLED_STORAGE "PACKAGE_INFO_PROP_APP_INSTALLED_STORAGE"
/**
- * @brief Definition for boolean property for filtering based on app info: Boolean property for filtering whether the package is nodisplay or not based on package info
+ * @brief Definition for boolean property for filtering based on app info: Boolean property for filtering whether the package is nodisplay or not based on package info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define PACKAGE_INFO_PROP_APP_NODISPLAY "PACKAGE_INFO_PROP_APP_NODISPLAY"
/**
- * @brief Definition for boolean property for filtering based on app info: Boolean property for filtering whether the package has the authority to manage task or not based on package info
+ * @brief Definition for boolean property for filtering based on app info: Boolean property for filtering whether the package has the authority to manage task or not based on package info.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
*/
#define PACKAGE_INFO_PROP_APP_TASKMANAGE "PACKAGE_INFO_PROP_APP_TASKMANAGE"
/**
- * @brief Definition for boolean property for filtering based on app info: Boolean property for filtering whether the application has been disabled
+ * @brief Definition for boolean property for filtering based on app info: Boolean property for filtering whether the application has been disabled.
* @since_tizen 4.0
*/
#define PACKAGE_INFO_PROP_APP_DISABLED "PACKAGE_INFO_PROP_APP_DISABLED"
/**
* @brief Enumeration for application component type.
- * @since_tizen 4.0
* @details A component is an application considered as a part of a package.
* The application component type indicates what type of
* a component an application is in a package.
+ * @since_tizen 4.0
* @see PACKAGE_INFO_PROP_APP_COMPONENT_TYPE
* @see app_info_get_app_component_type()
*/
/**
* @brief Creates the application information handle.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @remarks The @a app_info should be released using app_info_destroy().
* @param[in] app_id The application ID
* @param[out] app_info The application information handle
* @return @c 0 on success,
int app_info_get_app_id(app_info_h app_info, char **app_id);
/**
- * @brief Gets the executable path of the application
+ * @brief Gets the executable path of the application.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
* @remarks You must release @a exec path using free().
* @param[in] app_info The application information
/**
* @brief Clones the application information handle.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @remarks The @a clone should be released using app_info_destroy().
* @param[out] clone A newly created application information handle, if successfully cloned
* @param[in] app_info The application information
* @return @c 0 on success,
* @return @c 0 on success,
* otherwise a negative error value
* @retval #APP_MANAGER_ERROR_NONE Successful
+ * @retval #APP_MANAGER_ERROR_PERMISSION_DENIED Permission denied
* @retval #APP_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #APP_MANAGER_ERROR_IO_ERROR I/O error
- * @retval #APP_MANAGER_ERROR_PERMISSION_DENIED Permission denied
* @see app_info_create()
*/
int app_info_foreach_category(app_info_h app_info, app_info_category_cb callback, void *user_data);
* @brief Creates the application information filter handle from DB.
* All filter properties will be ANDed.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @remarks The @a handle should be released using app_info_filter_destroy().
* @param[out] handle The pointer to the application info filter handle
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Creates the application's metadata information filter handle from DB.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @remarks The @a handle should be released using app_info_metadata_filter_destroy().
* @param[out] handle The pointer to the application metadata info filter handle
* @return @c 0 on success,
* otherwise a negative error value
/**
* @brief Called when an application is launched or terminated.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
+ * @remarks Please don't try to free the handle of app_context, because it is managed by the framework.
* @param[in] app_context The application context of the application launched or terminated
* @param[in] event The application context event
* @param[in] user_data The user data passed from the foreach function
* @pre This function is called when an application gets launched or terminated, after you register this callback using app_manager_set_app_context_event_cb().
* @see app_manager_set_app_context_event_cb()
* @see app_manager_unset_app_context_event_cb()
- * @remarks Please don't try to free the handle of app_context, because it is managed by the framework.
*/
typedef void (*app_manager_app_context_event_cb) (app_context_h app_context, app_context_event_e event, void *user_data);
int app_manager_set_app_context_event_cb(app_manager_app_context_event_cb callback, void *user_data);
/**
- * @brief Unregisters the callback function.
+ * @brief Unregisters the callback function.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @see app_manager_app_context_event_cb()
*/
/**
* @brief Retrieves all application contexts of running applications.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
+ * @remarks In case of ui applications, sub apps in application groups will not be shown.
* @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,
* @retval #APP_MANAGER_ERROR_IO_ERROR Internal I/O error
* @post This function invokes app_manager_app_context_cb() for each application context.
* @see app_manager_app_context_cb()
- * @remarks In case of ui applications, sub apps in application groups will not be shown.
*/
int app_manager_foreach_app_context(app_manager_app_context_cb callback, void *user_data);
/**
* @brief Retrieves all application contexts of running applications including sub apps.
- * @details You can iterate all the running application contexts using this API.
- * This API is similar to app_manager_foreach_app_context() except that this API iterates application contexts including sub apps in application groups.
+ * @details You can iterate all the running application contexts using this function.
+ * This function is similar to app_manager_foreach_app_context() except that this function iterates application contexts including sub apps in application groups.
* @since_tizen 3.0
* @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 #APP_MANAGER_ERROR_NONE Successful
+ * @retval #APP_MANAGER_ERROR_PERMISSION_DENIED Permission denied
* @retval #APP_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #APP_MANAGER_ERROR_APP_NO_RUNNING App is not running
* @retval #APP_MANAGER_ERROR_REQUEST_FAILED Internal resume error
- * @retval #APP_MANAGER_ERROR_PERMISSION_DENIED Permission denied
*/
int app_manager_resume_app(app_context_h app_context);
/**
* @brief Terminates the back ground application.\n
- * UI applications that are in paused state or some service applications could be required to terminate by this API.
+ * UI applications that are in paused state or some service applications could be required to terminate by this function.
* @since_tizen @if MOBILE 2.4 @elseif WEARABLE 3.0 @endif
* @privlevel public
* @privilege %http://tizen.org/privilege/appmanager.kill.bgapp
* @return @c 0 on success,
* otherwise a negative error value
* @retval #APP_MANAGER_ERROR_NONE Successful
+ * @retval #APP_MANAGER_ERROR_PERMISSION_DENIED Permission denied
* @retval #APP_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #APP_MANAGER_ERROR_REQUEST_FAILED Failed to send terminate request
- * @retval #APP_MANAGER_ERROR_PERMISSION_DENIED Permission denied
*/
int app_manager_request_terminate_bg_app(app_context_h app_context);
* with an application ID.
* @details An application can only read the files of other application's shared data directory.
* @since_tizen @if MOBILE 2.3 @elseif WEARABLE 2.3.1 @endif
- * @remarks The specified @a path should be released with free(). @n
- * Since Tizen 3.0, the shared/data directory is supported only for the applications that declare the http://tizen.org/privilege/appdir.shareddata privilege.
- * The function will fail with #APP_MANAGER_ERROR_NOT_SUPPORTED if the privilege is not declared.
+ * @remarks The specified @a path should be released with free().\n
+ * Since Tizen 3.0, the shared/data directory is supported only for the applications that declare the http://tizen.org/privilege/appdir.shareddata privilege.
+ * The function will fail with #APP_MANAGER_ERROR_NOT_SUPPORTED if the privilege is not declared.
*
- * @param[in] app_id The ID of the application
- * @param[in,out] path The absolute path to the shared data directory of the application
+ * @param[in] app_id The ID of the application
+ * @param[out] path The absolute path to the shared data directory of the application
* specified with the @a app_id
* @return @c 0 on success,
* otherwise a negative error value
* @retval #APP_MANAGER_ERROR_NONE Successful
+ * @retval #APP_MANAGER_ERROR_NOT_SUPPORTED Not supported
* @retval #APP_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #APP_MANAGER_ERROR_NO_SUCH_APP No such application
* @retval #APP_MANAGER_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #APP_MANAGER_ERROR_NOT_SUPPORTED Not supported
*/
int app_manager_get_shared_data_path(const char *app_id, char **path);
* otherwise a negative error value
*
* @retval #APP_MANAGER_ERROR_NONE Successful
- * @retval #APP_MANAGER_ERROR_OUT_OF_MEMORY Out of memory
* @retval #APP_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #APP_MANAGER_ERROR_OUT_OF_MEMORY Out of memory
* @see app_manager_event_destroy()
*/
int app_manager_event_create(app_manager_event_h *handle);
* You can combine multiple status using OR operation which you want to listen.
* @since_tizen 3.0
*
- * @param [in] handle The app manager event handle
- * @param [in] status_type The status of the application
+ * @param[in] handle The app manager event handle
+ * @param[in] status_type The status of the application
*
* @return @c 0 on success,
* otherwise a negative error value
* otherwise a negative error value
*
* @retval #APP_MANAGER_ERROR_NONE Successful
- * @retval #APP_MANAGER_ERROR_REQUEST_FAILED Internal error
* @retval #APP_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #APP_MANAGER_ERROR_REQUEST_FAILED Internal error
*
* @see app_manager_event_create()
*/
* otherwise a negative error value
*
* @retval #APP_MANAGER_ERROR_NONE Successful
+ * @retval #APP_MANAGER_ERROR_PERMISSION_DENIED Permission denied
* @retval #APP_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
* @retval #APP_MANAGER_ERROR_OUT_OF_MEMORY Out of memory
* @retval #APP_MANAGER_ERROR_IO_ERROR Internal error
- * @retval #APP_MANAGER_ERROR_PERMISSION_DENIED Permission denied
*
* @see app_manager_event_create()
*/
* @privlevel platform
* @privilege %http://tizen.org/privilege/appmanager.kill
* @param[in] app_context The application context
- * @return @c 0 on success,
+ * @return @c 0 on success,
* otherwise a negative error value
- * @retval #APP_MANAGER_ERROR_NONE Successful
- * @retval #APP_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #APP_MANAGER_ERROR_REQUEST_FAILED Internal terminate error
- * @retval #APP_MANAGER_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #APP_MANAGER_ERROR_NONE Successful
+ * @retval #APP_MANAGER_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #APP_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #APP_MANAGER_ERROR_REQUEST_FAILED Internal terminate error
*/
int app_manager_terminate_app(app_context_h app_context);
* @param[in] app_id The ID of the application
* @param[in] display The display flag to enable/disable the splash screen
*
- * @return @c 0 on success,
- * otherwise a negative error value
- * @retval #APP_MANAGER_ERROR_NONE Successful
- * @retval #APP_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #APP_MANAGER_ERROR_OUT_OF_MEMORY Out of memory
- * @retval #APP_MANAGER_ERROR_PERMISSION_DENIED Permission denied
- * @retval #APP_MANAGER_ERROR_IO_ERROR Internal I/O error
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #APP_MANAGER_ERROR_NONE Successful
+ * @retval #APP_MANAGER_ERROR_PERMISSION_DENIED Permission denied
+ * @retval #APP_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #APP_MANAGER_ERROR_OUT_OF_MEMORY Out of memory
+ * @retval #APP_MANAGER_ERROR_IO_ERROR Internal I/O error
*/
int app_manager_set_splash_screen_display(const char *app_id, bool display);
-/*
+/**
* @brief Registers a callback function to be invoked when the application change status.
* @since_tizen 3.0
* @param[in] callback The callback function to register
- * @param[in] appid The appid to get status
- * @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 #APP_MANAGER_ERROR_NONE Successful
- * @retval #APP_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
- * @retval #APP_MANAGER_ERROR_IO_ERROR Internal I/O error
+ * @param[in] appid The appid to get status
+ * @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 #APP_MANAGER_ERROR_NONE Successful
+ * @retval #APP_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
+ * @retval #APP_MANAGER_ERROR_IO_ERROR Internal I/O error
* @retval #APP_MANAGER_ERROR_OUT_OF_MEMORY Out of memory
* @post It will invoke app_manager_app_context_status_cb() when the application is launched or terminated.
* @see app_manager_app_context_status_cb()
/**
* @brief Detaches the window of the application from its parent window.
* @since_tizen 3.0
- * @param[in] app_id The ID of the application
* @remarks This function is only available for platform level signed applications.
+ * @param[in] app_id The ID of the application
* @return @c 0 on success,
* otherwise a negative error value
* @retval #APP_MANAGER_ERROR_NONE Successful
*/
int app_manager_detach_window(const char *app_id);
-/*
+/**
* @brief Unregisters the callback function.
* @since_tizen 3.0
* @param[in] callback The registered callback function
- * @param[in] appid The registered appid
- * @return @c 0 on success,
- * otherwise a negative error value
- * @retval #APP_MANAGER_ERROR_NONE Successful
- * @retval #APP_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
+ * @param[in] appid The registered appid
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ * @retval #APP_MANAGER_ERROR_NONE Successful
+ * @retval #APP_MANAGER_ERROR_INVALID_PARAMETER Invalid parameter
* @see app_manager_app_context_status_cb()
*/
int app_manager_unset_app_context_status_cb(app_manager_app_context_status_cb callback, const char *appid);
projects / platform / core / api / app-manager.git / commitdiff