/*
* aul
*
- * Copyright (c) 2000 - 2011 Samsung Electronics Co., Ltd. All rights reserved.
- *
- * Contact: Jayoun Lee <airjany@samsung.com>, Sewook Park <sewook7.park@samsung.com>, Jaeho Lee <jaeho81.lee@samsung.com>
+ * Copyright (c) 2015 Samsung Electronics Co., Ltd. All rights reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
*
*/
-
-#ifndef __AUL_H__
-#define __AUL_H__
+#pragma once
#include <errno.h>
#include <bundle.h>
#endif
/**
- * @mainpage
- *
- * This is new version of Application Utility Library
- *
- * Almost function's input param is application package name(APN).\n
- * APN is application package name which is set by developer.\n
- * In case of in-house application, prefix is org.tizen.\n
- * It is different from debian package name.\n
- *
- * - Debian Package Name : Name which is managed by package manager
- * - Application Package Name : Name which is used by AUL
- * - Execution Path : real program executable path
- */
-
-/**
- * @open
- * @ingroup APPLICATION_FRAMEWORK
- * @defgroup aul Application Utility Library
- * @{
- */
-
-
-/**
- * @file aul.h
- * @brief Application Utility Library header
- *
- * Patched by Knhoon Baik <knhoon.baik@samsung.com>
- * Patched by Youmin Ha <youmin.ha@samsung.com>
- */
-
-/**
- * @addtogroup aul
- * @{
- */
-
-/**
* @brief Return values in AUL.
*/
typedef enum _aul_return_val {
+ AUL_R_ENOENT = -15, /**< App directory entry error */
AUL_R_EREJECTED = -14, /**< App disable for mode */
AUL_R_ENOAPP = -13, /**< Failed to find app ID or pkg ID */
AUL_R_EHIDDENFORGUEST = -11, /**< App hidden for guest mode */
AUL_R_ENOINIT = -2, /**< AUL handler NOT initialized */
AUL_R_ERROR = -1, /**< General error */
AUL_R_OK = 0 /**< General success */
-}aul_return_val;
+} aul_return_val;
enum app_status {
STATUS_LAUNCHING,
STATUS_DYING,
STATUS_HOME,
STATUS_NORESTART,
- STATUS_SERVICE
+ STATUS_SERVICE,
+ STATUS_TERMINATE,
};
-/** @} */
-
-/**
- * @defgroup aul_launch Primitive APIs to launch/resume/terminate application
- * @ingroup aul
- * @brief
- * APIs to launch/resume/terminate application
- * - Launch application based on application package name
- * - Resume application based on application package name
- * - Resume application based on pid (required root or inhouse permisssion)
- * - Terminate application base on pid (required root or inhouse permission)
- *
- * AUL internal information
- * - AUL grant pid, gid to launched application for security
- * - AUL send RESET/RESUME/TERM event for running application in case of single instance
- * - AUL set application enviroment based on desktop entry
- * - AUL support single instance / multi instance
- * - AUL support application data exchange format (bundle)
- */
-
-/**
- * @addtogroup aul_launch
- * @{
- */
-
-typedef enum _aul_type{
+typedef enum _aul_type {
AUL_START,
AUL_RESUME,
AUL_TERMINATE,
AUL_TERMINATE_BGAPP,
AUL_PAUSE,
-}aul_type;
-
-/** AUL internal private key */
-#define AUL_K_PKG_NAME "__AUL_PKG_NAME__"
-/** AUL internal private key */
-#define AUL_K_WAIT_RESULT "__AUL_WAIT_RESULT__"
-/** AUL internal private key */
-#define AUL_K_SEND_RESULT "__AUL_SEND_RESULT__"
-/** AUL internal private key */
-#define AUL_K_TASK_MANAGE "__AUL_TASK_MANAGE__"
-/** AUL internal private key */
-#define AUL_K_APP_TYPE "__AUL_APP_TYPE__"
-/** AUL internal private key - To check original caller's identity */
-#define AUL_K_ORG_CALLER_PID "__AUL_ORG_CALLER_PID__"
-/** AUL internal private key - To check forwarded callee app's pid */
-#define AUL_K_FWD_CALLEE_PID "__AUL_FWD_CALLEE_PID__"
-
-/** AUL internal private key */
-#define AUL_K_NO_CANCEL "__AUL_NO_CANCEL__"
+ AUL_WAKE,
+ AUL_SUSPEND,
+ AUL_WIDGET_CONTENT,
+ AUL_UPDATE_REQUESTED,
+} aul_type;
+
+typedef enum aul_widget_lifecycle_event {
+ AUL_WIDGET_LIFE_CYCLE_EVENT_APP_DEAD = 0,
+ AUL_WIDGET_LIFE_CYCLE_EVENT_CREATE = 1, /**< The widget is created */
+ AUL_WIDGET_LIFE_CYCLE_EVENT_DESTROY = 2, /**< The widget is destroyed */
+ AUL_WIDGET_LIFE_CYCLE_EVENT_PAUSE = 3, /**< The widget is paused */
+ AUL_WIDGET_LIFE_CYCLE_EVENT_RESUME = 4 /**< The widget is resumed */
+} aul_widget_lifecycle_event_e;
+
+typedef enum aul_widget_instance_event {
+ AUL_WIDGET_INSTANCE_EVENT_CREATE = 0,
+ AUL_WIDGET_INSTANCE_EVENT_DESTROY = 1,
+ AUL_WIDGET_INSTANCE_EVENT_TERMINATE = 2,
+ AUL_WIDGET_INSTANCE_EVENT_PAUSE = 3,
+ AUL_WIDGET_INSTANCE_EVENT_RESUME = 4,
+ AUL_WIDGET_INSTANCE_EVENT_UPDATE = 5,
+ AUL_WIDGET_INSTANCE_EVENT_PERIOD_CHANGED = 6,
+ AUL_WIDGET_INSTANCE_EVENT_SIZE_CHANGED = 7,
+ AUL_WIDGET_INSTANCE_EVENT_EXTRA_UPDATED = 8,
+ AUL_WIDGET_INSTANCE_EVENT_FAULT = 9,
+ AUL_WIDGET_INSTANCE_EVENT_APP_RESTART_REQUEST = 10,
+ AUL_WIDGET_INSTANCE_EVENT_CREATE_ABORTED = 11
+} aul_widget_instance_event_e;
/** AUL public key - To check caller's secuirty */
#define AUL_K_CALLER_PID "__AUL_CALLER_PID__"
/** AUL public key - To check callee's secuirty */
#define AUL_K_CALLEE_PID "__AUL_CALLEE_PID__"
-
/** AUL public key - added for multiuser mode */
#define AUL_K_CALLER_UID "__AUL_CALLER_UID__"
/** AUL public key - added for multiuser mode */
#define AUL_K_CALLEE_UID "__AUL_CALLEE_UID__"
/** AUL public key - added for multiuser mode */
#define AUL_K_TARGET_UID "__AUL_TARGET_UID__"
-
/** AUL public key - To check caller's secuirty */
#define AUL_K_CALLER_APPID "__AUL_CALLER_APPID__"
/** AUL public key - To check caller's secuirty */
#define AUL_K_CALLEE_APPID "__AUL_CALLEE_APPID__"
-
/** AUL public key - To find argv0 */
#define AUL_K_ARGV0 "__AUL_ARGV0__"
/** AUL public key - To measure launching time */
#define AUL_K_STARTTIME "__AUL_STARTTIME__"
-
/** AUL public key - To support launching based on mime type */
#define AUL_K_MIME_TYPE "__AUL_MIME_TYPE__"
/** AUL public key - To support launching based on mime type */
#define AUL_K_UNALIASED_MIME_TYPE "__AUL_UNALIASED_MIME_TYPE__"
/** AUL public key - To support launching based on mime type */
#define AUL_K_MIME_CONTENT "__AUL_MIME_CONTENT__"
-
/** AUL public key - To support launching based on service */
#define AUL_K_SERVICE_NAME "__AUL_SERVICE_NAME__"
-
/** AUL public key - To force launch app selector instead of lauchingn default app */
#define AUL_K_FORCE_LAUNCH_APP_SELECTOR "__AUL_FORCE_LAUNCH_APP_SELECTOR__"
-
/** AUL public key - To support debug argument */
#define AUL_K_DEBUG "__AUL_DEBUG__"
-
/** AUL public key - To support SDK */
#define AUL_K_SDK "__AUL_SDK__"
-
/** AUL public key - To support Media key */
#define AUL_K_MULTI_KEY "__AUL_MULTI_KEY__"
/** AUL public key - To support Media key */
#define AUL_K_MULTI_KEY_EVENT "__AUL_MULTI_KEY_EVENT__"
-
/** AUL public bundle value */
#define AUL_K_PRIVACY_APPID "__AUL_PRIVACY_APPID__"
-
-
/** AUL public bundle value - To support Media key*/
#define AUL_V_KEY_PRESSED "__AUL_KEY_PRESSED__"
/** AUL public bundle value - To support Media key*/
#define AUL_V_KEY_RELEASED "__AUL_KEY_RELEASED__"
+/** AUL public key - To support rua stat */
+#define AUL_SVC_K_RUA_STAT_CALLER "__K_RUA_STAT_CALLER__"
+#define AUL_SVC_K_RUA_STAT_TAG "__K_RUA_STAT_TAG__"
+/** AUL public key - To support rua delete */
+#define AUL_K_RUA_PKGNAME "__K_RUA_PKGNAME"
+/** AUL public key - To support rua delete */
+#define AUL_K_RUA_APPPATH "__K_RUA_APPPATH"
+/** AUL public key - To support rua add */
+#define AUL_K_RUA_ARG "__K_RUA_ARG"
+/** AUL public key - To support rua add */
+#define AUL_K_RUA_TIME "__K_RUA_TIME"
+/** AUL public bundle value */
+#define AUL_K_RUA_INSTANCE_ID "__K_RUA_INSTANCE_ID"
+/** AUL public bundle value */
+#define AUL_K_RUA_INSTANCE_NAME "__K_RUA_INSTANCE_NAME"
+/** AUL public bundle value */
+#define AUL_K_RUA_ICON "__K_RUA_ICON"
+/** AUL public bundle value */
+#define AUL_K_RUA_URI "__K_RUA_URI"
/** AUL internal private key */
+#define AUL_K_PKG_NAME "__AUL_PKG_NAME__"
+/** AUL internal private key */
+#define AUL_K_WAIT_RESULT "__AUL_WAIT_RESULT__"
+/** AUL internal private key */
+#define AUL_K_SEND_RESULT "__AUL_SEND_RESULT__"
+/** AUL internal private key */
+#define AUL_K_TASK_MANAGE "__AUL_TASK_MANAGE__"
+/** AUL internal private key */
+#define AUL_K_APP_TYPE "__AUL_APP_TYPE__"
+/** AUL internal private key - To check original caller's identity */
+#define AUL_K_ORG_CALLER_PID "__AUL_ORG_CALLER_PID__"
+/** AUL internal private key - To check forwarded callee app's pid */
+#define AUL_K_FWD_CALLEE_PID "__AUL_FWD_CALLEE_PID__"
+/** AUL internal private key */
+#define AUL_K_NO_CANCEL "__AUL_NO_CANCEL__"
+/** AUL internal private key */
#define AUL_K_EXEC "__AUL_EXEC__"
/** AUL internal private key */
#define AUL_K_MULTIPLE "__AUL_MULTIPLE__"
#define AUL_K_PACKAGETYPE "__AUL_PACKAGETYPE__"
/** AUL internal private key */
#define AUL_K_HWACC "__AUL_HWACC__"
-
-
/** AUL internal private key */
#define AUL_K_APPID "__AUL_APPID__"
/** AUL internal private key */
#define AUL_K_WID "__AUL_WID__"
/** AUL internal private key */
#define AUL_K_LEADER_PID "__AUL_LEADER_PID__"
-/** AUL internal private key - To support data control*/
+/** AUL internal private key - To support data control */
#define AUL_K_DATA_CONTROL_TYPE "__AUL_DATA_CONTROL_TYPE__"
/** AUL internal private key */
#define AUL_K_PKGID "__AUL_PKGID_"
+/** AUL internal private key */
+#define AUL_K_INTERNAL_POOL "__AUL_INTERNAL_POOL__"
+/** AUL internal private key */
+#define AUL_TEP_PATH "_AUL_TEP_PATH_"
+/** AUL internal private key */
+#define AUL_K_COMP_TYPE "__AUL_COMP_TYPE__"
+/** AUL internal private key */
+#define AUL_K_LOADER_ID "__AUL_LOADER_ID__"
+/** AUL internal private key */
+#define AUL_K_LOADER_PATH "__AUL_LOADER_PATH__"
+/** AUL internal private key */
+#define AUL_K_LOADER_EXTRA "__AUL_LOADER_EXTRA__"
+/** AUL internal private key */
+#define AUL_K_LOADER_NAME "__AUL_LOADER_NAME__"
+/** AUL internal private key */
+#define AUL_K_WAYLAND_DISPLAY "__AUL_WAYLAND_DISPLAY__"
+/** AUL internal private key */
+#define AUL_K_WAYLAND_WORKING_DIR "__AUL_WAYLAND_WORKING_DIR__"
+/** AUL internal private key */
+#define AUL_K_COM_SENDER_PID "__AUL_COM_SENDER_PID__"
+/** AUL internal private key */
+#define AUL_K_COM_ENDPOINT "__AUL_COM_ENDPOINT__"
+/** AUL internal private key */
+#define AUL_K_COM_PRIVILEGE "__AUL_COM_PRIVILEGE__"
+/** AUL internal private key */
+#define AUL_K_COM_PROPAGATE "__AUL_COM_PROPAGATE__"
+/** AUL internal private key */
+#define AUL_K_COM_FILTER "__AUL_COM_FILTER__"
+/** AUL internal private key */
+#define AUL_K_COM_RESULT "__AUL_COM_RESULT__"
+/** AUL internal private key */
+#define AUL_K_ROOT_PATH "__AUL_ROOT_PATH__"
+/** AUL internal private key */
+#define AUL_K_SEQ_NUM "__AUL_SEQ_NUM__"
+/** AUL internal private key */
+#define AUL_K_API_VERSION "__AUL_API_VERSION__"
+/** AUL internal private key */
+#define AUL_K_ALLOWED_BG "__AUL_ALLOWED_BG__"
+/** AUL internal private key */
+#define AUL_K_OWNER_PID "__AUL_OWNER_PID__"
+/** AUL internal private key */
+#define AUL_K_CHILD_PID "__AUL_CHILD_PID__"
+/** AUL internal private key */
+#define AUL_K_WIDGET_VIEWER "__AUL_WIDGET_VIEWER__"
+/** AUL internal private key */
+#define AUL_K_WIDGET_ID "__AUL_WIDGET_ID__"
+/** AUL internal private key */
+#define AUL_K_WIDGET_INSTANCE_ID "__AUL_WIDGET_INSTANCE_ID__"
+/** AUL internal private key */
+#define AUL_K_WIDGET_STATUS "__AUL_WIDGET_STATUS__"
+/** AUL internal private key */
+#define AUL_K_WIDGET_CONTENT_INFO "__AUL_WIDGET_CONTENT_INFO__"
+/** AUL internal private key */
+#define AUL_K_TARGET_PID "__AUL_TARGET_PID__"
+/** AUL internal private key */
+#define AUL_K_ALIAS_APPID "__AUL_ALIAS_APPID__"
+/** AUL internal private key */
+#define AUL_K_ORG_APPID "__AUL_ORG_APPID__"
+/** AUL internal private key */
+#define AUL_K_STATUS "__AUL_STATUS__"
+/** AUL internal private key */
+#define AUL_K_IS_SUBAPP "__AUL_IS_SUBAPP__"
+/** AUL internal private key */
+#define AUL_K_INSTANCE_ID "__AUL_INSTANCE_ID__"
+/** AUL internal private key */
+#define AUL_K_ORG_CALLER_UID "__AUL_ORG_CALLER_UID__"
+/** AUL internal private key */
+#define AUL_K_CHECKSUM "__AUL_CHECKSUM__"
+/** AUL internal private key */
+#define AUL_K_PRIVATE "__AUL_PRIVATE__"
+/** AUL internal private key */
+#define AUL_K_SCREEN_TYPE "__AUL_SCREEN_TYPE__"
+/** AUL internal private key */
+#define AUL_K_VIEWER_REF "__AUL_VIEWER_REF__"
+/** AUL internal private key */
+#define AUL_K_PARENT_APPID "__AUL_PARENT_APPID__"
+/** AUL internal private key */
+#define AUL_K_CHILD_APPID "__AUL_CHILD_APPID__"
+/** AUL internal private key */
+#define AUL_K_WIDGET_FAULT "__AUL_WIDGET_FAULT__"
+
/**
* @brief This is callback function for aul_launch_init
* @param[in] b In case of RESET events, bundle which is received from peer
* @param[in] data user-supplied data
*/
-typedef int (*aul_handler_fn) (aul_type type, bundle * b, void *data);
+typedef int (*aul_handler_fn)(aul_type type, bundle *b, void *data);
/**
* @par Description:
* @pre
* you must have aul handler to use this API.
* aul_luanch_init register aul handler.
- * @post
- * None
- * @see
- * None
* @code
* #include <aul.h>
* #include <bundle.h>
*
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*/
int aul_launch_init(aul_handler_fn handler, void *data);
* @pre
* you must have aul handler to use this API.
* aul_luanch_init register aul handler.
- * @post
- * None
* @see
* aul_launch_init
* @code
*
* @endcode
* @remark
- * If you use AppCore, you NEED NOT use this API.
+ * If you use AppCore, you NEED NOT use this API.
+ * This API is only available in User Session.
*/
int aul_launch_argv_handler(int argc, char **argv);
* @endcode
* @remark
* If you use AppCore, you NEED NOT to use this API.
+ * This API is only available in User Session.
*/
int aul_launch_local(bundle *b);
* @retval AUL_R_ECOM - internal AUL IPC error
* @retval AUL_R_ERROR - general error
*
- * @pre
- * None
- * @post
- * None
* @see
* aul_open_app
* @code
*
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*/
int aul_launch_app(const char *appid, bundle *kb);
+
+/**
+ * @par Description:
+ * This API launches application with the given bundle.
+ * If the application is not running or a multiple-instance one, this API launches with the given bundle.
+ * If the application is running, this API sends a RESET event to the App.
+ * While the application is running, if the application cannot receive the RESET event,
+ * this API returns a general error(AUL_R_ERROR).\n
+ * @par Purpose:
+ * This API is for caller.
+ * This API's purpose is to launch/reset application with given bundle.
+ * @par Typical use case:
+ * If you know the target application's pkgname and bundle types,
+ * you can use this API to launch/reset the application.
+ *
+ * @param[in] pkgname package name to be run as callee
+ * @param[in] kb bundle to be passed to callee
+ * @param[in] uid User ID to launch
+ * @return callee's pid if success, negative value(<0) if fail
+ * @retval AUL_R_OK - success
+ * @retval AUL_R_EINVAL - invaild package name
+ * @retval AUL_R_ECOM - internal AUL IPC error
+ * @retval AUL_R_ERROR - general error
+ *
+ * @see
+ * aul_open_app
+ * @remark
+ * This API is also available in System Session.
+ */
int aul_launch_app_for_uid(const char *appid, bundle *kb, uid_t uid);
/**
* @retval AUL_R_ECOM - internal AUL IPC error
* @retval AUL_R_ERROR - general error
*
- * @pre
- * None
- * @post
- * None
* @see
* aul_launch_app, aul_app_is_running, aul_resume_pid
* @code
* If you don't want to launch the app,
* you should check app's running state with aul_app_is_running.
* This API will launch the application if the application is not running.
+ * This API is only available in User Session.
*/
int aul_open_app(const char *appid);
/**
* @par Description:
+ * This API launches application, as menu screen launches the app.
+ * Thus, if the applocation is running, this API sends a RESUME event to the app.
+ * If the application is not running, this API launches the app.
+ * While the application is running, if the application cannot receive the RESUME event,
+ * AUL tries to raise the application's default window.
+ *
+ * @par Purpose:
+ * This API is for caller.
+ * This API's purpose is to resume/launch application
+ * @par Typical use case:
+ * If you only want to show application with previous state or default state, Use this API.
+ *
+ * @param[in] pkgname package name to be resume as callee
+ * @param[in] uid User ID
+ * @return callee's pid if success, negative value(<0) if fail
+ * @retval AUL_R_OK - success
+ * @retval AUL_R_EINVAL - invaild package name
+ * @retval AUL_R_ECOM - internal AUL IPC error
+ * @retval AUL_R_ERROR - general error
+ *
+ * @remark
+ * If you don't want to launch the app,
+ * you should check app's running state with aul_app_is_running.
+ * This API will launch the application if the application is not running.
+ * This API is only available to System user.
+ */
+int aul_open_app_for_uid(const char *appid, uid_t uid);
+
+/**
+ * @par Description:
* This API trigger to resume application
* If the application is running, this API send a resume event to the App.
* If the application is not running, this API returns fail.
* @retval AUL_R_ECOM - internal AUL IPC error
* @retval AUL_R_ERROR - general error
*
- * @pre
- * None
- * @post
- * None
* @see
* aul_launch_app, aul_app_is_running, aul_resume_pid
* @deprecated
* This API will launch the application if the application is not running.
* If you want to only resume without launching in multiple instance application model,
* you should use aul_resume_pid.
+ * This API is only available in User Session.
*/
int aul_resume_app(const char *appid);
/**
* @par Description:
* This API trigger to resume application
+ * If the application is running, this API send a resume event to the App.
+ * If the application is not running, this API returns fail.
+ * Although the application is running, if the application cannot receive resume event,
+ * AUL try to raise the application's default windows.
+ * @par Purpose:
+ * This API is for caller.
+ * This API's purpose is to send resume event.
+ * @par Typical use case:
+ * If you only want to show application with previous state or default state, Use this API.
+ *
+ * @param[in] pkgname package name to be resume as callee
+ * @param[in] uid User ID
+ * @return callee's pid if success, negative value(<0) if fail
+ * @retval AUL_R_OK - success
+ * @retval AUL_R_EINVAL - invaild package name
+ * @retval AUL_R_ECOM - internal AUL IPC error
+ * @retval AUL_R_ERROR - general error
+ *
+ * @remark
+ * If you don't want to launch the app,
+ * you should check app's running state with aul_app_is_running.
+ * This API will launch the application if the application is not running.
+ * If you want to only resume without launching in multiple instance application model,
+ * you should use aul_resume_pid.
+ * This API is only available to System user.
+ */
+int aul_resume_app_for_uid(const char *appid, uid_t uid);
+
+/**
+ * @par Description:
+ * This API trigger to resume application
* If the application is running, this API send a resume event to the App.
* If the application is not running, this API return AUL_R_ERROR.
* Although the application is running, if the application cannot receive resume event,
* @retval AUL_R_ERROR - general error (include application is not running)
* @warning This API need to require root or inhouse permisssion \n
* If you have not the permission, this API return AUL_R_ERROR. \n
- * @pre
- * None
- * @post
- * None
* @see
* aul_launch_app
* @code
*
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*/
int aul_resume_pid(int pid);
/**
* @par Description:
+ * This API trigger to resume application
+ * If the application is running, this API send a resume event to the App.
+ * If the application is not running, this API return AUL_R_ERROR.
+ * Although the application is running, if the application cannot receive resume event,
+ * AUL try to raise the application's default windows.
+ * @par Purpose:
+ * This API is for caller.
+ * This API's purpose is to send resume event.
+ * @par Typical use case:
+ * In multiple application model, If you want to only resume specific application, Use this API
+ *
+ * @param[in] pid application's pid to be resumed
+ * @param[in] uid User ID
+ * @return 0 if success, negative value(<0) if fail
+ * @retval AUL_R_OK - success
+ * @retval AUL_R_EINVAL - invaild pid
+ * @retval AUL_R_ECOM - internal AUL IPC error
+ * @retval AUL_R_ERROR - general error (include application is not running)
+ * @warning This API need to require root or inhouse permisssion \n
+ * If you have not the permission, this API return AUL_R_ERROR. \n
+ * @remark
+ * This API is only available to System user.
+*/
+int aul_resume_pid_for_uid(int pid, uid_t uid);
+
+/**
+ * @par Description:
* This API trigger to terminate application
*
* If the application is running, this API send a terminate event to the App. \n
* @retval AUL_R_ERROR - general error
* @warning This API need to require root or inhouse permisssion. \n
*
- * @pre
- * None
- * @post
- * None
- * @see
- * None
* @code
* #include <aul.h>
* #include <bundle.h>
* @endcode
* @remark
* If you have not the permission, this API return AUL_R_ERROR. \n
+ * This API is only available in User Session.
*/
int aul_terminate_pid(int pid);
-int aul_terminate_bgapp_pid(int pid);
-int aul_terminate_pid_without_restart(int pid);
-int aul_terminate_pid_async(int pid);
-/** @} */
+/**
+ * @par Description:
+ * This API trigger to terminate application
+ *
+ * If the application is running, this API send a terminate event to the App. \n
+ * If the app cannot receive the event, AUL kill forcely the application.\n
+ * @par Purpose:
+ * This API's purpose is to kill application
+ * @par Typical use case:
+ * In general, Application like Task Manager use this API.
+ *
+ * This API need to require root or inhouse permisssion. \n
+ *
+ * @param[in] pid application's pid to be terminated
+ * @param[in] uid User ID
+ * @return 0 if success, negative value(<0) if fail
+ * @retval AUL_R_OK - success
+ * @retval AUL_R_EINVAL - invaild pid
+ * @retval AUL_R_ECOM - internal AUL IPC error
+ * @retval AUL_R_ERROR - general error
+ * @warning This API need to require root or inhouse permisssion. \n
+ *
+ * @remark
+ * If you have not the permission, this API return AUL_R_ERROR. \n
+ * This API is only available to System user.
+ */
+int aul_terminate_pid_for_uid(int pid, uid_t uid);
+
+/**
+ * @par Description:
+ * This API trigger to terminate application asynchronously
+ *
+ * If the application is running, this API send a terminate event to the App. \n
+ * If the app cannot receive the event, AUL kill forcely the application.\n
+ * @par Purpose:
+ * This API's purpose is to kill application
+ * @par Typical use case:
+ * In general, Application like Task Manager use this API.
+ *
+ * This API need to require root or inhouse permisssion. \n
+ *
+ * @param[in] pid application's pid to be terminated
+ * @return 0 if success, negative value(<0) if fail
+ * @retval AUL_R_OK - success
+ * @retval AUL_R_EINVAL - invaild pid
+ * @retval AUL_R_ECOM - internal AUL IPC error
+ * @retval AUL_R_ERROR - general error
+ * @warning This API need to require root or inhouse permisssion. \n
+ * @remark
+ * If you have not the permission, this API return AUL_R_ERROR. \n
+ * This API is only available in User Session.
+*/
+int aul_terminate_pid_async(int pid);
/**
- * @defgroup aul_info Helper APIs to get running application information
- * @ingroup aul
- * @brief
- * API to get running application information (state, executable path, ..)
- * - get application package name from pid
- * - get application running state
- * - get application list of runnning applications
+ * @par Description:
+ * This API trigger to terminate application asynchronously
+ *
+ * If the application is running, this API send a terminate event to the App. \n
+ * If the app cannot receive the event, AUL kill forcely the application.\n
+ * @par Purpose:
+ * This API's purpose is to kill application
+ * @par Typical use case:
+ * In general, Application like Task Manager use this API.
+ *
+ * This API need to require root or inhouse permisssion. \n
+ *
+ * @param[in] pid application's pid to be terminated
+ * @param[in] uid User ID
+ * @return 0 if success, negative value(<0) if fail
+ * @retval AUL_R_OK - success
+ * @retval AUL_R_EINVAL - invaild pid
+ * @retval AUL_R_ECOM - internal AUL IPC error
+ * @retval AUL_R_ERROR - general error
+ * @warning This API need to require root or inhouse permisssion. \n
+ * @remark
+ * If you have not the permission, this API return AUL_R_ERROR. \n
+ * This API is only available to System user.
*/
+int aul_terminate_pid_async_for_uid(int pid, uid_t uid);
+
+/**
+ * @par Description:
+ * This API trigger to terminate application synchronously
+ *
+ * If the application is running, this API sends a terminate event to the application. \n
+ * And then, this API waits until the application is terminated successfully. \n
+ * If the app cannot receive the event, AUL kill forcely the application. \n
+ * @par Purpose:
+ * This API's purpose is to kill application
+ * @par Typical use case:
+ * In general, Application like Task Manager use this API.
+ *
+ * This API need to require root or platform level permisssion. \n
+ *
+ * @param[in] pid application's pid to be terminated
+ * @return 0 if success, negative value(<0) if fail
+ * @retval AUL_R_OK - success
+ * @retval AUL_R_EINVAL - invaild pid
+ * @retval AUL_R_ECOM - internal AUL IPC error
+ * @retval AUL_R_ERROR - general error
+ * @warning This API need to require root or platform level permisssion. \n
+ * @remark
+ * If you have not the permission, this API return AUL_R_ERROR. \n
+ * This API is only available in User Session.
+*/
+int aul_terminate_pid_sync(int pid);
/**
- * @addtogroup aul_info
- * @{
+ * @par Description:
+ * This API trigger to terminate application synchronously
+ *
+ * If the application is running, this API send a terminate event to the application. \n
+ * And then, this API waits until the application is terminated successfully. \n
+ * If the app cannot receive the event, AUL kill forcely the application. \n
+ * @par Purpose:
+ * This API's purpose is to kill application
+ * @par Typical use case:
+ * In general, Application like Task Manager use this API.
+ *
+ * This API need to require root or platform level permisssion. \n
+ *
+ * @param[in] pid application's pid to be terminated
+ * @param[in] uid User ID
+ * @return 0 if success, negative value(<0) if fail
+ * @retval AUL_R_OK - success
+ * @retval AUL_R_EINVAL - invaild pid
+ * @retval AUL_R_ECOM - internal AUL IPC error
+ * @retval AUL_R_ERROR - general error
+ * @warning This API need to require root or platform level permisssion. \n
+ * @remark
+ * If you have not the permission, this API return AUL_R_ERROR. \n
+ * This API is only available to System user.
*/
+int aul_terminate_pid_sync_for_uid(int pid, uid_t uid);
/**
*@brief Running application's information structure retrieved by AUL
*/
typedef struct _aul_app_info {
int pid; /**< app's pid if running*/
- char* pkg_name; /**< application id */
- char* app_path; /**< application excutable path */
- char* appid;
+ char *pkg_name; /**< application id */
+ char *app_path; /**< application excutable path */
+ char *appid;
+ char *pkgid; /**< package id */
+ int status; /**< app's status */
+ int is_sub_app; /**< state whether sub app of app group */
+ char *instance_id;
} aul_app_info;
/**
* @retval 1 app_name is running now.
* @retval 0 app_name is NOT running now.
*
- * @pre
- * None
- * @post
- * None
- * @see
- * None
* @code
* #include <aul.h>
*
*
* @endcode
* @remark
- * None
-*
-*/
+ * This API is only available in User Session.
+ *
+ */
int aul_app_is_running(const char *appid);
/**
* @par Description:
+ * This API ask a application is running by application package name.
+ * @par Purpose:
+ * To know whether some application is running or not, use this API
+ * @par Typical use case:
+ * For example, If you want to know browser application running,
+ * you can check it by using this API.
+ *
+ * @param[in] pkgname application package name
+ * @param[in] uid User ID
+ * @return true / false
+ * @retval 1 app_name is running now.
+ * @retval 0 app_name is NOT running now.
+ *
+ * @endcode
+ * @remark
+ * This API is only available to System User.
+ */
+int aul_app_is_running_for_uid(const char *appid, uid_t uid);
+
+/**
+ * @par Description:
* This API use to get running application list.
* This API call iter_fn with each aul_app_info of running apps when running application is found.
* @par Purpose:
* If you want to get running application list, use this API
- * This API give you running applications which has SLP desktop file.
* @par Typical use case:
* In general, this API is used by task manager appllication. (running application list viewer)
*
* @param[in] iter_fn iterator function
- * @param[in] data user-supplied data for iter_fn
+ * @param[in] user_data user-supplied data for iter_fn
* @return 0 if success, negative value(<0) if fail
* @retval AUL_R_OK - success
* @retval AUL_R_ERROR - internal error
*
- * @pre
- * None
- * @post
- * None
- * @see
- * None
* @code
* #include <aul.h>
*
* This API should use if you want to know running application which has desktop files.
* If you want to get all process list, you must iterate process information by using proc filesystem
* Or, If you want to get all window list, you must iterate XWindows by using XWindow APIs
+ * This API is only available in User Session.
+ */
+int aul_app_get_running_app_info(aul_app_info_iter_fn iter_fn, void *user_data);
+
+/**
+ * @par Description:
+ * This API use to get running application list.
+ * This API call iter_fn with each aul_app_info of running apps when running application is found.
+ * @par Purpose:
+ * If you want to get running application list, use this API
+ * @par Typical use case:
+ * In general, this API is used by task manager appllication. (running application list viewer)
+ *
+ * @param[in] iter_fn iterator function
+ * @param[in] user_data user-supplied data for iter_fn
+ * @param[in] uid User ID
+ * @return 0 if success, negative value(<0) if fail
+ * @retval AUL_R_OK - success
+ * @retval AUL_R_ERROR - internal error
+ *
+ * @remark
+ * This API should use if you want to know running application which has desktop files.
+ * If you want to get all process list, you must iterate process information by using proc filesystem
+ * Or, If you want to get all window list, you must iterate XWindows by using XWindow APIs
+ * This API is only available to System user.
+ */
+int aul_app_get_running_app_info_for_uid(aul_app_info_iter_fn iter_fn, void *user_data, uid_t uid);
+
+/**
+ * @par Description:
+ * This API use to get all running application list, including sub app.
+ * This API call iter_fn with each aul_app_info of running apps when running application is found.
+ * @par Purpose:
+ * If you want to get all running application list, use this API
+ * @par Typical use case:
+ * In general, this API is used by task manager application. (running application list viewer)
+ *
+ * @param[in] iter_fn iterator function
+ * @param[in] user_data user-supplied data for iter_fn
+ * @return 0 if success, negative value(<0) if fail
+ * @retval AUL_R_OK - success
+ * @retval AUL_R_ERROR - internal error
+ *
+ * @code
+ * #include <aul.h>
+ *
+ * int iterfunc_status(const aul_app_info *info, void *data)
+ * {
+ * printf("\t==========================\n");
+ * printf("\t pid: %d\n", info->pid);
+ * printf("\t appid: %s\n", info->appid);
+ * printf("\t app_path: %s\n", info->app_path);
+ * printf("\t pkgid: %s\n", info->pkgid);
+ * printf("\t status: %d\n", info->status);
+ * printf("\t is_sub_app : %d\n", info->is_sub_app);
+ * printf("\t==========================\n");
+ * return 0;
+ * }
+ *
+ * int iterate_running_apps()
+ * {
+ * return aul_app_get_all_running_app_info(iterfunc_status,NULL);
+ * }
+ *
+ * @endcode
+ * @remark
+ * This API should use if you want to know running application which has desktop files.
+ * If you want to get all process list, you must iterate process information by using proc filesystem
+ * Or, If you want to get all window list, you must iterate XWindows by using XWindow APIs
+ * This API is only available in User Session.
+ */
+int aul_app_get_all_running_app_info(aul_app_info_iter_fn iter_fn, void *user_data);
+
+/**
+ * @par Description:
+ * This API use to get all running application list, including sub app.
+ * This API call iter_fn with each aul_app_info of running apps when running application is found.
+ * @par Purpose:
+ * If you want to get all running application list, use this API
+ * @par Typical use case:
+ * In general, this API is used by task manager application. (running application list viewer)
+ *
+ * @param[in] iter_fn iterator function
+ * @param[in] user_data user-supplied data for iter_fn
+ * @param[in] uid User ID
+ * @return 0 if success, negative value(<0) if fail
+ * @retval AUL_R_OK - success
+ * @retval AUL_R_ERROR - internal error
+ *
+ * @remark
+ * This API should use if you want to know running application which has desktop files.
+ * If you want to get all process list, you must iterate process information by using proc filesystem
+ * Or, If you want to get all window list, you must iterate XWindows by using XWindow APIs
+ * This API is only available to System user.
*/
-int aul_app_get_running_app_info(aul_app_info_iter_fn iter_fn, void *data);
+int aul_app_get_all_running_app_info_for_uid(aul_app_info_iter_fn iter_fn, void *user_data, uid_t uid);
/**
* @par Description:
* @return 0 if success, negative value(<0) if fail
* @retval AUL_R_OK - success
* @retval AUL_R_ERROR - no such a package name
- * @pre
- * None
- * @post
- * None
- * @see
- * None
* @code
* #include <aul.h>
* #include <bundle.h>
*
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*/
int aul_app_get_pkgname_bypid(int pid, char *pkgname, int len);
* @return 0 if success, negative value(<0) if fail
* @retval AUL_R_OK - success
* @retval AUL_R_ERROR - no such a appid
- * @pre
- * None
- * @post
- * None
- * @see
- * None
+ *
* @code
* #include <aul.h>
* #include <bundle.h>
*
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*/
int aul_app_get_pkgid_bypid(int pid, char *pkgid, int len);
/**
* @par Description:
+ * This API get application pkgid by pid
+ * @par Purpose:
+ * If you want to get pkgid of running application, use this API
+ * @par Typical use case:
+ * In general, You can use this API when you want to know caller's information.
+ *
+ * @param[in] pid given pid
+ * @param[out] pkgid package id
+ * @param[in] len length of pkgid
+ * @param[in] uid User ID
+ * @return 0 if success, negative value(<0) if fail
+ * @retval AUL_R_OK - success
+ * @retval AUL_R_ERROR - no such a appid
+ *
+ * @remark
+ * This API is also available to System user.
+*/
+int aul_app_get_pkgid_bypid_for_uid(int pid, char *pkgid, int len, uid_t uid);
+
+/**
+ * @par Description:
* This API get application appid by pid
* @par Purpose:
* If you want to get appid of running application, use this API
* @return 0 if success, negative value(<0) if fail
* @retval AUL_R_OK - success
* @retval AUL_R_ERROR - no such a appid
- * @pre
- * None
- * @post
- * None
- * @see
- * None
* @code
* #include <aul.h>
* #include <bundle.h>
*
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*/
int aul_app_get_appid_bypid(int pid, char *appid, int len);
-/** @} */
-
-/**
- * @defgroup aul_mime High-level APIs to launch default application based on mime type
- * @ingroup aul
- * @brief
- * AUL High-level APIs based on mime type
- *
- * These APIs provide two functionality\n
- *
- * -# To launch default application to open a file based on its MIME type \n
- * For example, you can launch the default video player to open .mp4 files
- * or launch the default browser to open HTML files \n
- * -# To launch default application to process given content \n
- * For example, you can launch the default e-mail application to process
- * "nice@samsung.com" e-mail address.
- */
-
/**
- * @addtogroup aul_mime
- * @{
- */
+ * @par Description:
+ * This API get application appid by pid
+ * @par Purpose:
+ * If you want to get appid of running application, use this API
+ * @par Typical use case:
+ * In general, You can use this API when you want to know caller's information.
+ *
+ * @param[in] pid given pid
+ * @param[out] appid application id
+ * @param[in] len length of pkgname
+ * @param[in] uid User ID
+ * @return 0 if success, negative value(<0) if fail
+ * @retval AUL_R_OK - success
+ * @retval AUL_R_ERROR - no such a appid
+ * @remark
+ * This API is also available to System user.
+*/
+int aul_app_get_appid_bypid_for_uid(int pid, char *appid, int len, uid_t uid);
/**
* @par Description:
* @retval AUL_R_ECOM - internal AUL IPC error
* @retval AUL_R_ERROR - general error
*
- * @pre
- * None
- * @post
- * None
- * @see
- * None
* @code
* #include <aul.h>
*
*
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*
*/
int aul_open_file(const char* filename);
* @retval AUL_R_ECOM - internal AUL IPC error
* @retval AUL_R_ERROR - general error
*
- * @pre
- * None
- * @post
- * None
* @see
* aul_open_file, aul_get_mime_from_file
* @code
*
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*/
int aul_open_file_with_mimetype(const char *filename, const char *mimetype);
* @retval AUL_R_ECOM - internal AUL IPC error
* @retval AUL_R_ERROR - general error or no found mimetype
*
- * @pre
- * None
- * @post
- * None
- * @see
- * None
* @code
* #include <aul.h>
*
*
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*
*/
int aul_open_content(const char* content);
* @retval AUL_R_EINVAL - invalid argument(mimetype)
* @retval AUL_R_ERROR - general error or no found mimetype
*
- * @pre
- * None
- * @post
- * None
* @see
* aul_set_defapp_with_mime
* @code
*
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*
*/
int aul_get_defapp_from_mime(const char *mimetype, char *defapp, int len);
* @retval AUL_R_EINVAL - invalid argument(mimetype)
* @retval AUL_R_ERROR - general error
*
- * @pre
- * None
- * @post
- * None
* @see
* aul_get_defapp_from_mime
* @code
*
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*/
int aul_set_defapp_with_mime(const char *mimetype, const char *defapp);
* @retval AUL_R_EINVAL - invalid argument(filename)
* @retval AUL_R_ERROR - general error
*
- * @pre
- * None
- * @post
- * None
- * @see
- * None
* @code
* #include <aul.h>
*
*
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*/
int aul_get_mime_from_file(const char *filename, char *mimetype, int len);
* @retval AUL_R_EINVAL - invalid argument(content)
* @retval AUL_R_ERROR - general error
*
- * @pre
- * None
- * @post
- * None
- * @see
- * None
* @code
* #include <aul.h>
*
*
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*/
int aul_get_mime_from_content(const char *content, char *mimetype, int len);
* @retval AUL_R_EINVAL - invalid argument(content)
* @retval AUL_R_ERROR - general error (no such mime type)
*
- * @pre
- * None
- * @post
- * None
- * @see
- * None
* @code
* #include <aul.h>
*
*
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*/
int aul_get_mime_icon(const char *mimetype, char *iconname, int len);
* @retval AUL_R_EINVAL - invalid argument(mimetype)
* @retval AUL_R_ERROR - general error (no mimetype or no extenstion)
*
- * @pre
- * None
- * @post
- * None
* @see
* aul_get_mime_description
* @code
* @remark
* Some mimetype don't have extension.
* In that case, You can use aul_get_mime_description.
- *
+ * This API is only available in User Session.
*/
int aul_get_mime_extension(const char *mimetype, char *extlist, int len);
* @retval AUL_R_EINVAL - invalid argument(mimetype)
* @retval AUL_R_ERROR - general error (no mimetype or no descrition)
*
- * @pre
- * None
- * @post
- * None
* @see
* aul_get_mime_extension
* @code
*
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*/
int aul_get_mime_description(const char *mimetype, char *desc, int len);
* }
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*
*/
int aul_create_result_bundle(bundle *inb, bundle **outb);
* }
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*
*/
int aul_send_service_result(bundle *b);
* @retval AUL_R_OK - success
* @retval AUL_R_ERROR - general error
*
- * @pre
- * None
- * @post
- * None
* @see
* aul_listen_app_launch_signal
* @code
*
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*
*/
int aul_listen_app_dead_signal(int (*func) (int, void *), void *data);
* @retval AUL_R_OK - success
* @retval AUL_R_ERROR - general error
*
- * @pre
- * None
- * @post
- * None
* @see
* aul_listen_app_dead_signal
* @code
*
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*
*/
int aul_listen_app_launch_signal(int (*func) (int, void *), void *data);
-int aul_listen_booting_done_signal(int (*func) (int, void *), void *data);
-
-int aul_listen_cooldown_signal(int (*func) (const char *, void *), void *data);
-
-int aul_listen_app_status_signal(int (*func) (int, int, void *), void *data);
-
-const char *aul_get_app_external_root_path(void);
-const char *aul_get_app_root_path(void);
-const char *aul_get_app_data_path(void);
-const char *aul_get_app_cache_path(void);
-const char *aul_get_app_resource_path(void);
-const char *aul_get_app_tep_resource_path(void);
-const char *aul_get_app_shared_data_path(void);
-const char *aul_get_app_shared_resource_path(void);
-const char *aul_get_app_shared_trusted_path(void);
-const char *aul_get_app_external_data_path(void);
-const char *aul_get_app_external_cache_path(void);
-const char *aul_get_app_external_shared_data_path(void);
-const char *aul_get_app_specific_path(void);
-const char *aul_get_app_external_specific_path(void);
-int aul_get_app_shared_data_path_by_appid(const char *app_id, char **path);
-int aul_get_app_shared_resource_path_by_appid(const char *app_id, char **path);
-int aul_get_app_shared_trusted_path_by_appid(const char *app_id, char **path);
-int aul_get_app_external_shared_data_path_by_appid(const char *app_id, char **path);
-int aul_get_usr_app_shared_data_path_by_appid(const char *app_id, char **path, uid_t uid);
-int aul_get_usr_app_shared_resource_path_by_appid(const char *app_id, char **path, uid_t uid);
-int aul_get_usr_app_shared_trusted_path_by_appid(const char *app_id, char **path, uid_t uid);
-int aul_get_usr_app_external_shared_data_path_by_appid(const char *app_id, char **path, uid_t uid);
-
-
-typedef int (*subapp_fn)(void *data);
-
-int aul_set_subapp(subapp_fn cb, void *data);
-int aul_subapp_terminate_request_pid(int pid);
-int aul_is_subapp(void);
-int aul_kill_pid(int pid);
-int aul_add_caller_cb(int pid, void (*caller_cb) (int, void *), void *data);
-int aul_remove_caller_cb(int pid);
-int aul_invoke_caller_cb(int pid);
-
-void aul_set_preinit_window(void *evas_object);
-void* aul_get_preinit_window(const char *win_name);
-void aul_set_preinit_background(void *evas_object);
-void* aul_get_preinit_background(void);
-void aul_set_preinit_conformant(void *evas_object);
-void* aul_get_preinit_conformant(void);
-void aul_set_preinit_appid(const char *appid);
-void aul_set_preinit_pkgid(const char *pkgid);
-
-int aul_update_freezer_status(int pid, const char* type);
-
-int aul_send_app_launch_request_signal(int pid, const char* appid, const char* pkgid, const char* type);
-int aul_send_app_resume_request_signal(int pid, const char* appid, const char* pkgid, const char *type);
-int aul_send_app_terminate_request_signal(int pid, const char* appid, const char* pkgid, const char *type);
-int aul_send_app_status_change_signal(int pid, const char* appid, const char* pkgid, const char* status, const char *type);
-int aul_send_app_terminated_signal(int pid);
-int aul_send_app_group_signal(int owner_pid, int child_pid, const char *child_pkgid);
+/**
+ * @par Description:
+ * This API sets callback fuction that will be called when applications are launched.
+ * @par Purpose:
+ * This API's purpose is to listen the application launching event.
+ * In general, task manager Application need this API.
+ *
+ * @param[in] func callback function
+ * @param[in] data user data
+ * @return 0 if success, negative value if fail
+ * @retval AUL_R_OK - success
+ * @retval AUL_R_ERROR - general error
+ *
+ * @see
+ * aul_listen_app_dead_signal
+ * @code
+ * #include <aul.h>
+ *
+ * int app_launch_handler(int pid, const char *app_id, void *data)
+ * {
+ * printf("===> %s : %d, %s\n", __FUNCTION__, pid, app_id);
+ * return 0;
+ * }
+ *
+ * void dead_listen()
+ * {
+ * aul_listen_app_launch_signal(app_launch_handler, NULL);
+ * }
+ *
+ * @endcode
+ * @remark
+ * This API is only available in User Session.
+ *
+ */
+int aul_listen_app_launch_signal_v2(int (*func) (int, const char *, void *), void *data);
/**
* @par Description:
* @param[in] pid pid of application
* @return 0 or greater if success, nagative value if fail
* @retval STATUS_LAUNCHING
- * @retval STATUS_CREATED
- * @retval STATUS_FOCUS
* @retval STATUS_VISIBLE
* @retval STATUS_BG
* @retval STATUS_DYING
- * @retval STATUS_HOME
* @retval STATUS_NORESTART
* @see
* aul_status_update
- * @pre
- * None
- * @post
- * None
* @code
* #include <aul.h>
*
* {
* int status;
* status = aul_app_get_status_bypid(info->pid);
- * if (status == STATUS_FOCUS) {
+ * if (status == STATUS_VISIBLE) {
* printf("%s has focus", info->app_id);
* (int *)data = info->pid;
* return -1;
* }
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*/
int aul_app_get_status_bypid(int pid);
/**
+ * @par Description:
+ * This API gets status of specified application process id.
+ * @par Purpose:
+ * This API's purpose is to get the application's status.
+ *
+ * @param[in] pid pid of application
+ * @param[in] uid User ID
+ * @return 0 or greater if success, nagative value if fail
+ * @retval STATUS_LAUNCHING
+ * @retval STATUS_VISIBLE
+ * @retval STATUS_BG
+ * @retval STATUS_DYING
+ * @retval STATUS_NORESTART
+ *
+ * @remark
+ * This API is only available to System user.
+ */
+int aul_app_get_status_bypid_for_uid(int pid, uid_t uid);
+
+/**
+ * @par Description:
+ * This API gets the status of specified application id.
+ * @par Purpose:
+ * This API's purpose is to get the status of the application.
+ *
+ * @param[in] appid application ID
+ * @return 0 or greater if success, nagative value if fail
+ * @retval STATUS_LAUNCHING
+ * @retval STATUS_FOCUS
+ * @retval STATUS_VISIBLE
+ * @retval STATUS_BG
+ * @retval STATUS_DYING
+ * @retval STATUS_NORESTART
+ * @see
+ * aul_status_update
+ * @code
+ * #include <aul.h>
+ *
+ * int func(void)
+ * {
+ * int status;
+ *
+ * status = aul_app_get_status("org.tizen.helloworld");
+ * if (status == STATUS_FOCUS)
+ * printf("org.tizen.helloworld has focus");
+ *
+ * return 0;
+ * }
+ *
+ * @endcode
+ * @remark
+ * This API is only available in User Session.
+ */
+int aul_app_get_status(const char *appid);
+
+/**
+ * @par Description:
+ * This API gets the status of specified application id.
+ * @par Purpose:
+ * This API's purpose is to get the status of the application
+ *
+ * @param[in] appid application ID
+ * @param[in] uid User ID
+ * @return 0 or greater if success, nagative value if fail
+ * @retval STATUS_LAUNCHING
+ * @retval STATUS_FOCUS
+ * @retval STATUS_VISIBLE
+ * @retval STATUS_BG
+ * @retval STATUS_DYING
+ * @retval STATUS_NORESTART
+ *
+ * @remark
+ * This API is only available to System user.
+ */
+int aul_app_get_status_for_uid(const char *appid, uid_t uid);
+
+/**
* @par Description
* This API sets callback function that on application status changed.
* @par Purpose:
* @retval AUL_R_ERROR - general error
* @see
* aul_remove_status_local_cb
- * @pre
- * None
- * @post
- * None
* @code
* #include <aul.h>
*
* int status_changed(int status, void *data)
* {
- * if (status == STATUS_FOCUS)
- * printf("%d has focus\n", getpid());
- *
* if (status == STATUS_VISIBLE)
* printf("%d resume\n", getpid());
*
- * if (status == STATUS_BG0
+ * if (status == STATUS_BG)
* printf("%d pause\n", getpid());
* }
*
* }
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*
*/
int aul_add_status_local_cb(int (*func) (int, void *), void *data);
* @retval AUL_R_OK - success
* @retval AUL_R_ERROR - general error
*
- * @pre
- * None
- * @post
- * None
* @see
* aul_add_status_local_cb
* @code
*
* int status_changed(int status, void *data)
* {
- * if (status == STATUS_FOCUS)
- * printf("%d has focus\n", getpid());
- *
* if (status == STATUS_VISIBLE)
* printf("%d resume\n", getpid());
*
- * if (status == STATUS_BG0
+ * if (status == STATUS_BG)
* printf("%d pause\n", getpid());
* }
*
*
* @endcode
* @remark
- * None
+ * This API is only available in User Session.
*
*/
int aul_remove_status_local_cb(int (*func) (int, void *), void *data);
-int aul_invoke_status_local_cb(int status);
-typedef int (*data_control_provider_handler_fn) (bundle *b, int request_id, void *data);
-int aul_set_data_control_provider_cb(data_control_provider_handler_fn handler);
-int aul_unset_data_control_provider_cb(void);
-int aul_pause_app(const char *appid);
-int aul_pause_pid(int pid);
-int aul_reload_appinfo(void);
-int aul_status_update(int status);
-int aul_running_list_update(char *appid, char *app_path, char *pid);
+/*
+ * This API is only for appfw internally.
+ */
+int aul_set_process_group(int parent_pid, int child_pid);
-void aul_app_group_add(int leader_pid, int pid, int wid);
-void aul_app_group_remove(int pid);
-void aul_app_group_attach_window(int parent_wid, int child_wid);
-void aul_app_group_detach_window(int child_wid);
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_terminate_bgapp_pid(int pid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_terminate_pid_without_restart(int pid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_terminate_pid_sync_without_restart(int pid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_terminate_pid_sync_without_restart_for_uid(int pid, uid_t uid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+const char *aul_get_app_external_root_path(void);
+
+/*
+ * This API is only for Appfw internally.
+ */
+const char *aul_get_app_root_path(void);
+
+/*
+ * This API is only for Appfw internally.
+ */
+const char *aul_get_app_data_path(void);
+
+/*
+ * This API is only for Appfw internally.
+ */
+const char *aul_get_app_cache_path(void);
+
+/*
+ * This API is only for Appfw internally.
+ */
+const char *aul_get_app_resource_path(void);
+
+/*
+ * This API is only for Appfw internally.
+ */
+const char *aul_get_app_tep_resource_path(void);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_get_app_shared_data_path(char **path);
+
+/*
+ * This API is only for Appfw internally.
+ */
+const char *aul_get_app_shared_resource_path(void);
+
+/*
+ * This API is only for Appfw internally.
+ */
+const char *aul_get_app_shared_trusted_path(void);
+
+/*
+ * This API is only for Appfw internally.
+ */
+const char *aul_get_app_external_data_path(void);
+
+/*
+ * This API is only for Appfw internally.
+ */
+const char *aul_get_app_external_cache_path(void);
+
+/*
+ * This API is only for Appfw internally.
+ */
+const char *aul_get_app_external_shared_data_path(void);
+
+/*
+ * This API is only for Appfw internally.
+ */
+const char *aul_get_app_specific_path(void);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_get_app_shared_data_path_by_appid(const char *app_id, char **path);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_get_app_shared_resource_path_by_appid(const char *app_id, char **path);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_get_app_shared_trusted_path_by_appid(const char *app_id, char **path);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_get_app_external_shared_data_path_by_appid(const char *app_id, char **path);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_get_usr_app_shared_data_path_by_appid(const char *app_id, char **path, uid_t uid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_get_usr_app_shared_resource_path_by_appid(const char *app_id, char **path, uid_t uid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_get_usr_app_shared_trusted_path_by_appid(const char *app_id, char **path, uid_t uid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_get_usr_app_external_shared_data_path_by_appid(const char *app_id, char **path, uid_t uid);
+
+/*
+ * This type is only for Appfw internally.
+ */
+typedef int (*subapp_fn)(void *data);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_set_subapp(subapp_fn cb, void *data);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_subapp_terminate_request_pid(int pid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_is_subapp(void);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_kill_pid(int pid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_add_caller_cb(int pid, void (*caller_cb) (int, void *), void *data);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_remove_caller_cb(int pid, void *data);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_invoke_caller_cb(void *data);
+
+/*
+ * This API is only for Appfw internally.
+ */
+void aul_set_preinit_window(void *evas_object);
+
+/*
+ * This API is only for Appfw internally.
+ */
+void* aul_get_preinit_window(const char *win_name);
+
+/*
+ * This API is only for Appfw internally.
+ */
+void aul_set_preinit_background(void *evas_object);
+
+/*
+ * This API is only for Appfw internally.
+ */
+void* aul_get_preinit_background(void);
+
+/*
+ * This API is only for Appfw internally.
+ */
+void aul_set_preinit_conformant(void *evas_object);
+
+/*
+ * This API is only for Appfw internally.
+ */
+void* aul_get_preinit_conformant(void);
+
+/*
+ * This API is only for Appfw internally.
+ */
+void aul_set_preinit_appid(const char *appid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+void aul_set_preinit_pkgid(const char *pkgid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+void aul_set_preinit_root_path(const char *root_path);
+
+/*
+ * This API is only for Appfw internally.
+ */
+const char *aul_get_preinit_root_path(void);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_update_freezer_status(int pid, const char* type);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_send_app_launch_request_signal(int pid, const char* appid, const char* pkgid, const char* type);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_send_app_resume_request_signal(int pid, const char* appid, const char* pkgid, const char *type);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_send_app_terminate_request_signal(int pid, const char* appid, const char* pkgid, const char *type);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_send_app_status_change_signal(int pid, const char* appid, const char* pkgid, const char* status, const char *type);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_send_app_terminated_signal(int pid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_send_app_group_signal(int owner_pid, int child_pid, const char *child_pkgid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_invoke_status_local_cb(int status);
+
+/*
+ * This type is only for Appfw internally.
+ */
+typedef int (*data_control_provider_handler_fn) (bundle *b, int request_id, void *data);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_set_data_control_provider_cb(data_control_provider_handler_fn handler);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_unset_data_control_provider_cb(void);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_pause_app(const char *appid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_pause_app_for_uid(const char *appid, uid_t uid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_pause_pid(int pid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_pause_pid_for_uid(int pid, uid_t uid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_reload_appinfo(void);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_status_update(int status);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_running_list_update(char *appid, char *app_path, char *pid);
+
+/*
+ * This API is only for Appfw internally.
+ */
int aul_app_group_get_window(int pid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_app_group_set_window(int wid);
+
+/*
+ * This API is only for Appfw internally.
+ */
void aul_app_group_get_leader_pids(int *cnt, int **pids);
+
+/*
+ * This API is only for Appfw internally.
+ */
void aul_app_group_get_group_pids(int leader_pid, int *cnt, int **pids);
+
+/*
+ * This API is only for Appfw internally.
+ */
int aul_app_group_get_leader_pid(int pid);
+
+/*
+ * This API is only for Appfw internally.
+ */
int aul_app_group_clear_top(void);
+
+/*
+ * This API is only for Appfw internally.
+ */
int aul_app_group_is_top(void);
-int aul_request_data_control_socket_pair(bundle *b, int *fd);
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_app_group_get_fg_flag(int pid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+void aul_app_group_lower(int *exit);
+
+/*
+ * This API is only for Appfw internally.
+ */
+void aul_app_group_get_idle_pids(int *cnt, int **pids);
+
+/**
+ * @par Description:
+ * This API puts some app below the caller app
+ * @par Purpose:
+ * This API's purpose is to reorder window stack limitedly.
+ *
+ * @param[in] below_appid The appid to be reordered below the caller app
+ * @return 0 success, negative value(<0) if fail
+ *
+ * @remark
+ * below_appid should be main app which have been launched before.
+ * This API is only available in User Session.
+*/
+int aul_app_group_activate_below(const char *below_appid);
+
+/**
+ * @par Description:
+ * This API puts some app above the caller app
+ * @par Purpose:
+ * This API's purpose is to reorder window stack limitedly.
+ *
+ * @param[in] above_appid The appid to be reordered above the caller app
+ * @return 0 if success, negative value(<0) if fail
+ *
+ * @remark
+ * above_appid should be main app which have been launched before.
+ * This API is only available in User Session.
+*/
+int aul_app_group_activate_above(const char *above_appid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_request_data_control_socket_pair(bundle *b, int *fd);
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_request_message_port_socket_pair(int *fd);
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_listen_booting_done_signal(int (*func) (int, void *), void *data);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_listen_cooldown_signal(int (*func) (const char *, void *), void *data);
+
+/**
+ * @par Description:
+ * This API registers a callback function that will be called when the
+ * status of the application is changed.
+ * @par Purpose:
+ * This API is for monitoring the status of all applications.
+ *
+ * @param[in] func callback function
+ * @param[in] data user data
+ * @return 0 if success, negative value if fail
+ * @retval AUL_R_OK - success
+ * @retval AUL_R_ERROR - general error
+ *
+ * @code
+ * #include <aul.h>
+ *
+ * int app_status_handler(int pid, int status, void *data)
+ * {
+ * const char *app_status;
+ *
+ * switch (status) {
+ * case 0:
+ * app_status = "STATUS_LAUNCHING";
+ * break;
+ * case 3:
+ * app_status = "STATUS_VISIBLE";
+ * break;
+ * case 4:
+ * app_status = "STATUS_BACKGROUND";
+ * break;
+ * case 5:
+ * app_status = "STATUS_FOCUS";
+ * break;
+ * default:
+ * app_status = "STATUS_UNKNOWN";
+ * }
+ *
+ * printf("pid: %d, status: %s", pid, status);
+ * return 0;
+ * }
+ *
+ * int main(int argc, char **argv)
+ * {
+ * int ret;
+ *
+ * ret = aul_listen_app_status_signal(app_status_handler, NULL);
+ * if (ret != AUL_R_OK) {
+ * printf("Failed to add status handler");
+ * return -1;
+ * }
+ *
+ * ...
+ *
+ * return 0;
+ * }
+ * @endcode
+ */
+int aul_listen_app_status_signal(int (*func)(int, int, void *), void *data);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_check_tep_mount(const char *tep_path);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_is_tep_mount_dbus_done(const char *tep_string);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_forward_app(const char *appid, bundle *kb);
+
+/**
+ * @par Description:
+ * This API create custom launchpad-loader
+ * @par Purpose:
+ * This API's purpose is to make a slot for custom loader.
+ * Once it is made, added loader will make a candidate process to use.
+ *
+ * @param[in] loader_path The file name of the custom loader binary including full path
+ * @param[in] extra A bundle to be passed to the custom loader
+ * @return Loader ID if success, negative value(<0) if fail
+ *
+ * @remark
+ * This API is only for Appfw internally.
+ * This API is only available in User Session.
+*/
+int aul_add_loader(const char *loader_path, bundle *extra);
+
+/**
+ * @par Description:
+ * This API create custom launchpad-loader
+ * @par Purpose:
+ * This API's purpose is to make a slot for custom loader.
+ * Once it is made, added loader will make a candidate process to use.
+ *
+ * @param[in] loader_path The file name of the custom loader binary including full path
+ * @param[in] extra A bundle to be passed to the custom loader
+ * @param[in] uid User ID
+ * @return Loader ID if success, negative value(<0) if fail
+ *
+ * @remark
+ * This API is only for Appfw internally.
+ * This API is only available to System user.
+*/
+int aul_add_loader_for_uid(const char *loader_path, bundle *extra, uid_t uid);
+
+
+/**
+ * @par Description:
+ * This API destroy custom launchpad-loader
+ * @par Purpose:
+ * This API's purpose is to remove a slot for custom loader.
+ * Once it is removed, the prepared process will be removed as well.
+ *
+ * @param[in] loader_id Loader ID
+ * @return 0 if success, negative value(<0) if fail
+ *
+ * @remark
+ * This API is only for Appfw internally.
+ * This API is only available in User Session.
+*/
+int aul_remove_loader(int loader_id);
+
+/**
+ * @par Description:
+ * This API destroy custom launchpad-loader
+ * @par Purpose:
+ * This API's purpose is to remove a slot for custom loader.
+ * Once it is removed, the prepared process will be removed as well.
+ *
+ * @param[in] loader_id Loader ID
+ * @param[in] uid User ID
+ * @return 0 if success, negative value(<0) if fail
+ *
+ * @remark
+ * This API is only for Appfw internally.
+ * This API is only available to System user.
+*/
+int aul_remove_loader_for_uid(int loader_id, uid_t uid);
+
+/**
+ * @par Description
+ * This API gets specified application process id.
+ * @par Purpose:
+ * The purpose of this API is to get the pid of specified application.
+ *
+ * @param[in] appid application name
+ * @return callee's pid if success, negative value(<0) if fail
+ *
+ * @remark
+ * This API is only available in User Session.
+ */
+int aul_app_get_pid(const char *appid);
+
+/**
+ * @par Description
+ * This API gets specified application process id.
+ * @par Purpose:
+ * The purpose of this API is to get the pid of specified application.
+ *
+ * @param[in] appid application name
+ * @param[in] uid User ID
+ * @return callee's pid if success, negative value(<0) if fail
+ *
+ * @remark
+ * This API is only available to System user.
+ */
+int aul_app_get_pid_for_uid(const char *appid, uid_t uid);
+
+/**
+ * @par Description:
+ * This function update rua stat.
+ *
+ * @param[in] b Bundle object contains caller and tag information.
+ * @param[in] uid Target uid
+ *
+ * @return 0 if success, negative value(<0) if fail
+ * @see None
+ * @remarks This API is only for Appfw internally.
+ *
+ * @par Sample code:
+ * @code
+#include <aul.h>
+
+...
+{
+ int r;
+ bundle *b = bundle_create();
+ bundle_add_str(b, AUL_SVC_K_RUA_STAT_CALLER, caller);
+ bundle_add_str(b, AUL_SVC_K_RUA_STAT_TAG, tag);
+
+ r = aul_update_rua_stat_for_uid(b);
+}
+
+ * @endcode
+ **/
+int aul_update_rua_stat_for_uid(bundle *b, uid_t uid);
+
+/**
+ * @par Description:
+ * This function add rua history.
+ *
+ * @param[in] b Bundle object Target Package name or app path.
+ * @param[in] uid Target uid
+ *
+ * @return 0 if success, negative value(<0) if fail
+ * @see None
+ * @remarks This API is only for Appfw internally.
+ *
+ * @par Sample code:
+ * @code
+#include <aul.h>
+
+...
+{
+ int r;
+ bundle *b = bundle_create();
+ if (pkg_name)
+ bundle_add_str(b, AUL_K_RUA_PKGNAME, pkg_name);
+ else if (app_path)
+ bundle_add_str(b, AUL_K_RUA_APPPATH, app_path);
+
+ r = aul_add_rua_history_for_uid(b);
+}
+
+ * @endcode
+ **/
+int aul_add_rua_history_for_uid(bundle *b, uid_t uid);
+
+/**
+ * @par Description:
+ * This function delete rua history.
+ *
+ * @param[in] b Bundle object Target Package name. If NULL or has no value, delete all rua history.
+ * @param[in] uid Target uid
+ *
+ * @return 0 if success, negative value(<0) if fail
+ * @see None
+ * @remarks This API is only for Appfw internally.
+ *
+ * @par Sample code:
+ * @code
+#include <aul.h>
+
+...
+{
+ int r;
+ bundle *b = NULL;
+ if (pkg_name) {
+ b = bundle_create();
+ bundle_add_str(b, AUL_K_RUA_PKGNAME, pkg_name);
+ }
+ r = aul_delete_rua_history_for_uid(b, getuid());
+}
+
+ * @endcode
+ **/
+int aul_delete_rua_history_for_uid(bundle *b, uid_t uid);
+
+
+/**
+ * @par Description:
+ * This function sets the default application(application id) associated with operatioin, uri and mime-type.
+ *
+ * @param[in] b Bundle object Target application id and operation, uri and mime-type.
+ *
+ * @return 0 if success, negative value(<0) if fail
+ * @see None
+ * @remarks This API is only for Appfw internally.
+ *
+ * @par Sample code:
+ * @code
+#include <aul.h>
+#include <aul_svc.h>
+
+...
+{
+ int r;
+ bundle *b = bundle_create();
+
+ const char *appid = "org.tizen.test";
+ const char *operation = "test_operation";
+ const char *mime_type = "test_mime";
+ const char *uri = "test_uri";
+
+ aul_svc_set_operation(b, operation);
+ aul_svc_set_mime(b, mime_type);
+ aul_svc_set_uri(b, uri);
+
+ aul_svc_set_appid(b, appid)
+
+ r = aul_set_default_app_by_operation(b);
+}
+
+ * @endcode
+ **/
+int aul_set_default_app_by_operation(bundle *b);
+
+/**
+ * @par Description:
+ * This API unset the default application(application id) associated with operation, uri and mime-type.
+ *
+ * @param[in] app_id The ID of the application
+ *
+ * @return 0 if success, negative value(<0) if fail
+ *
+ * @pre None.
+ * @post None.
+ * @see None.
+ * @remarks None.
+ *
+ * @par Sample code:
+ * @code
+#include <aul.h>
+
+...
+{
+ aul_unset_default_app_by_operation("org.tizen.test");
+}
+ * @endcode
+ *
+ */
+int aul_unset_default_app_by_operation(const char *app_id);
+
+/**
+ * @par Description:
+ * Sends the launch request asynchronously.
+ *
+ * @param[in] appid The application ID
+ * @param[in] kb The Bundle data
+ * @return a pid of the callee on success,
+ * otherwise a negative error value
+ * @retval AUL_R_OK - Successful
+ * @retval AUL_R_EINVAL - Invalid parameter
+ * @retval AUL_R_ECOM - Internal AUL IPC error
+ * @retval AUL_R_ERROR - General error
+ *
+ * @remark
+ * This API is only available in User Session.
+ * This API doesn't check whether the callee application is executed successfully.
+ * If the caller application is equal to the callee application, this API can return AUL_R_OK.
+ */
+int aul_launch_app_async(const char *appid, bundle *kb);
+
+/**
+ * @par Description:
+ * Sends the launch request asynchronously.
+ *
+ * @param[in] appid The application ID
+ * @param[in] kb The Bundle data
+ * @param[in] uid User ID
+ * @return a pid of the callee on success,
+ * otherwise a negative error value
+ * @retval AUL_R_OK - Successful
+ * @retval AUL_R_EINVAL - Invalid parameter
+ * @retval AUL_R_ECOM - Internal AUL IPC error
+ * @retval AUL_R_ERROR - General error
+ *
+ * @remark
+ * This API is only available to System user.
+ * This API doesn't check whether the callee application is executed successfully.
+ * If the caller application is equal to the callee application, this API can return AUL_R_OK.
+ */
+int aul_launch_app_async_for_uid(const char *appid, bundle *kb, uid_t uid);
+
+/**
+ * @par Description:
+ * This API request launchpad to make candidate processes.
+ *
+ * @return 0 if success, negative value(<0) if fail
+ *
+ * @remark
+ * This API is only available in User Session.
+ */
+int aul_prepare_candidate_process(void);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_widget_instance_add(const char *widget_id, const char *instance_id);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_widget_instance_del(const char *widget_id, const char *instance_id);
+
+/*
+ * This API is only for Appfw internally.
+ */
+typedef void (*aul_widget_instance_foreach_cb)(const char *instance_id, void *data);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_widget_instance_foreach(const char *widget_id, aul_widget_instance_foreach_cb cb, void *data);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_widget_instance_update(const char *widget_id, const char *instance_id, bundle *b);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_widget_instance_count(const char *widget_id);
+
+/**
+ * @par Description:
+ * This API gets the last caller process id of specified application process id.
+ * @par Purpose:
+ * This API's purpose is to get the application's last caller process id.
+ *
+ * @param[in] pid pid of application
+ * @return caller pid if success, nagative value if fail
+ *
+ * @remark
+ * This API is only available in User Session.
+ */
+int aul_app_get_last_caller_pid(int pid);
+
+/**
+ * @par Description:
+ * This API gets the last caller process id of specified application process id.
+ * @par Purpose:
+ * This API's purpose is to get the last caller process id of the application.
+ *
+ * @param[in] pid pid of application
+ * @param[in] uid User ID
+ * @return caller pid if success, nagative value if fail
+ *
+ * @remark
+ * This API is only available in System users.
+ */
+int aul_app_get_last_caller_pid_for_uid(int pid, uid_t uid);
+
+/**
+ * @par Description:
+ * This API trigger to resume application asynchronously.
+ * If the application is running, this API send a resume event to the App.
+ * If the application is not running, this API return AUL_R_ERROR.
+ * Although the application is running, if the application cannot receive resume event,
+ * AUL try to raise the application's default windows.
+ * @par Purpose:
+ * This API is for caller.
+ * This API's purpose is to send resume event.
+ * @par Typical use case:
+ * In multiple application model, If you want to only resume specific application, Use this API
+ *
+ * @param[in] pid application's pid to be resumed
+ * @return 0 if success, negative value(<0) if fail
+ * @retval AUL_R_OK - success
+ * @retval AUL_R_EINVAL - invaild pid
+ * @retval AUL_R_ECOM - internal AUL IPC error
+ * @retval AUL_R_ERROR - general error (include application is not running)
+ * @warning This API need to require root or inhouse permisssion \n
+ * If you have not the permission, this API return AUL_R_ERROR. \n
+ * @remark
+ * This API is only available to User Session.
+ */
+int aul_resume_pid_async(int pid);
+
+/**
+ * @par Description:
+ * This API trigger to resume application asynchronously.
+ * If the application is running, this API send a resume event to the App.
+ * If the application is not running, this API return AUL_R_ERROR.
+ * Although the application is running, if the application cannot receive resume event,
+ * AUL try to raise the application's default windows.
+ * @par Purpose:
+ * This API is for caller.
+ * This API's purpose is to send resume event.
+ * @par Typical use case:
+ * In multiple application model, If you want to only resume specific application, Use this API
+ *
+ * @param[in] pid application's pid to be resumed
+ * @param[in] uid User ID
+ * @return 0 if success, negative value(<0) if fail
+ * @retval AUL_R_OK - success
+ * @retval AUL_R_EINVAL - invaild pid
+ * @retval AUL_R_ECOM - internal AUL IPC error
+ * @retval AUL_R_ERROR - general error (include application is not running)
+ * @warning This API need to require root or inhouse permisssion \n
+ * If you have not the permission, this API return AUL_R_ERROR. \n
+ * @remark
+ * This API is only available to System user.
+ */
+int aul_resume_pid_async_for_uid(int pid, uid_t uid);
+
+/**
+ * @par Description:
+ * This API set the alias appid.
+ * The alias appid is only available for the aul_svc_set_appid() API.
+ * If the appid is not available, this API returns an error.
+ *
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/systemsettings.admin
+ * @param[in] alias_appid an alias application ID
+ * @param[in] appid an application ID
+ * @return 0 if success, negative value(<0) if fail
+ *
+ * @remark
+ * This API is only available to User Session.
+ */
+int aul_set_alias_appid(const char *alias_appid, const char *appid);
+
+/**
+ * @par Description:
+ * This API unset the alias appid.
+ *
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/systemsettings.admin
+ * @param[in] alias_appid an alias application ID
+ * @return 0 if success, negative value(<0) if fail
+ *
+ * @remark
+ * This API is only available to User Session.
+ */
+int aul_unset_alias_appid(const char *alias_appid);
+
+/**
+ * @par Description:
+ * This API activates the alias information based on the given appid.
+ *
+ * @privlevel platform
+ * @privilege %http://tizen.org/privilege/systemsettings.admin
+ * @param[in] appid an application ID
+ * @return 0 if success, negative value(<0) if fail
+ *
+ * @remark
+ * This API is only available to User Session.
+ */
+int aul_enable_alias_info(const char *appid);
+
+/**
+ * @par Description:
+ * This API deactivates the alias information based on the given appid.
+ *
+ * @privlebel platform
+ * @privilege %http://tizen.org/privilege/systemsettings.admin
+ * @param[in] appid an application ID
+ * @return 0 if success, negative value(<0) if fail
+ *
+ * @remark
+ * This API is only available to User Session.
+ */
+int aul_disable_alias_info(const char *appid);
+
+/**
+ * This API is only for Appfw internally.
+ */
+typedef int (*app_status_cb)(aul_app_info *info, int ctx_status, void *data);
+
+/**
+ * This API is only for Appfw internally.
+ */
+typedef struct status_listen_s *status_listen_h;
+
+/**
+ * @par Description:
+ * Registers a callback function to be invoked when the application change status.
+ *
+ * @param[in] appid The application ID to get status
+ * @param[in] callback The callback function to register
+ * @param[in] data The user data to be passed to the callback function
+ * @param[out] handle The status listen handle
+ * @return @c 0 on success,
+ * otherwise a negative error value
+ */
+int aul_listen_app_status(const char *appid, app_status_cb callback,
+ void *data, status_listen_h *handle);
+int aul_listen_app_status_for_uid(const char *appid, app_status_cb callback,
+ void *data, status_listen_h *handle, uid_t uid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_widget_instance_get_content(const char *widget_id, const char *instance_id, char **content);
-/** @} */
+/**
+ * @par Description:
+ * Gets running application instance info
+ * This API calls the iter_fn with the aul_app_info when running app instance info is found.
+ *
+ * @param[in] iter_fn iterative function
+ * @param[in] user_data User data
+ * @return 0 if success, negative value(<0) if fail
+ * @retval AUL_R_OK Successful
+ * @retval AUL_R_ERROR General error
+ * @retval AUL_R_EINVAL Invalid parameter
+ */
+int aul_app_get_running_app_instance_info(aul_app_info_iter_fn iter_fn,
+ void *user_data);
+int aul_app_get_running_app_instance_info_for_uid(aul_app_info_iter_fn iter_fn,
+ void *user_data, uid_t uid);
+
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_app_get_instance_id_bypid(int pid, char *instance_id, int len);
+int aul_app_get_instance_id_bypid_for_uid(int pid, char *instance_id,
+ int len, uid_t uid);
+/*
+ * This API is only for Appfw internally.
+ */
+int aul_resume_app_by_instance_id(const char *appid, const char *instance_id);
+int aul_resume_app_by_instance_id_for_uid(const char *appid,
+ const char *instance_id, uid_t uid);
+
+/**
+ * This API is only for Appfw internally.
+ */
+int aul_ignore_app_status(status_listen_h handle);
+/**
+ * This API is only for Appfw internally.
+ */
+int aul_widget_notify_exit(void);
#ifdef __cplusplus
}
#endif
-#endif /* __AUL_H__ */
-
-/* vi: set ts=8 sts=8 sw=8: */
projects / platform / core / appfw / aul-1.git / blobdiff