Main Page | Modules | Namespace List | Class Hierarchy | Data Structures | Directories | File List | Namespace Members | Data Fields | Globals

appmgr.h File Reference


Detailed Description

Header file for MAX Application Manager APIs.Contains the SDK API for the application server and its associated client library.

#include <sys/types.h>
#include <glib.h>
#include <hiker/ipc.h>
#include <hiker/types.h>
#include <hiker/config_defines.h>
#include <hiker/traces.h>

Go to the source code of this file.

Defines

#define ALP_STATUS_APP_PARAM   ((alp_status_t)ALP_CLASS_APPSERVER | 0x00010000)
#define ALP_STATUS_APP_IPC   ((alp_status_t)ALP_CLASS_APPSERVER | 0x00020000)
#define ALP_STATUS_APP_NOT_FOUND   ((alp_status_t)ALP_CLASS_APPSERVER | 0x00030000)
#define ALP_STATUS_APP_NO_CONTEXT   ((alp_status_t)ALP_CLASS_APPSERVER | 0x00040000)
#define ALP_STATUS_APP_NO_LAUNCHPAD   ((alp_status_t)ALP_CLASS_APPSERVER | 0x00050000)
#define ALP_STATUS_APP_MSG   ((alp_status_t)ALP_CLASS_APPSERVER | 0x00060000)
#define ALP_STATUS_APP_RUNNING   ((alp_status_t)ALP_CLASS_APPSERVER | 0x00070000)
#define ALP_STATUS_APP_MEM   ((alp_status_t)ALP_CLASS_APPSERVER | 0x00080000)
#define ALP_STATUS_APP_LAUNCHPAD   ((alp_status_t)ALP_CLASS_APPSERVER | 0x00090000)
#define ALP_STATUS_APP_BLOCKED   ((alp_status_t)ALP_CLASS_APPSERVER | 0x000A0000)
#define ALP_APP_PROP_NAME   "name"
#define ALP_APP_PROP_VENDOR   "vendor"
#define ALP_APP_PROP_BACKGROUNDING   "backgrounding"
#define ALP_APP_PROP_HIDDEN   "hidden"
#define ALP_APP_PROP_JUMP_LIST   "jump-list"
#define ALP_APP_PROP_ENABLE_THEME   "enable-theme"
#define ALP_APP_PROP_TRANSIENT   "transient"
#define ALP_APP_PROP_UPDATE   "update-menu"
#define ALP_APP_PROP_SETTINGS   "settings-menu"
#define ALP_APP_PROP_PREVENT_DELETE   "prevent-delete"
#define ALP_APP_PROP_PREVENT_COPY   "prevent-copy"
#define ALP_APP_PROP_ICON   "icon"
#define ALP_APP_PROP_VERSION   "version"
#define ALP_APP_PROP_BG_UNSUPPORTED   "unsupported"
 This is the default value for ALP_APP_PROP_BACKGROUNDING, and indicates the application only supports being launched as the primary application.
#define ALP_APP_PROP_BG_SUPPORTED   "supported"
 This value for ALP_APP_PROP_BACKGROUNDING indicates the application can run in the background (i.e.
#define ALP_APP_PROP_BG_PREFERRED   "preferred"
 This value for ALP_APP_PROP_BACKGROUNDING indicates the application prefers to run in the background while resources are available, but does not require it.
#define ALP_APP_PROP_BG_REQUIRED   "required"
 This value for ALP_APP_PROP_BACKGROUNDING indicates the application needs to be left running in the background in order to properly do its work.
#define PKG_ID_MAX_LEN   256
#define ALP_APP_PRIMARY   "--alp-primary"
 The application is the new "primary" main UI app, and should display its full UI.
#define ALP_APP_BACKGROUNDED   "--alp-backgrounded"
 The application is no longer the primary UI app.
#define ALP_APP_DISPLAY   "--alp-display"
 The application should display a particular piece of data.
#define ALP_APP_FIND   "--alp-find"
 The application should search for a particular term.
#define ALP_APP_FIND_CANCEL   "--alp-find-cancel"
 The application should cancel ongoing searches.
#define ALP_APP_DEBUG   "--alp-debug"
 Indicates that the application should be prepared for debugging.
#define ALP_APP_NOTIFY   "--alp-notify"
 The application is being launched or relaunched to handle a notification.
#define ALP_APP_EXCHANGE   "--alp-exchange"
 The application is being launched or relaunched to run an exchange handler.
#define ALP_APP_ALARM   "--alp-alarm"
 The application is being launched because one of its alarms went off.
#define ALP_APP_ALERT   "--alp-alert"
 The application is being launched in order to receive an attention event.
#define ALP_APP_TRANSIENT   "--alp-transient"
 The application is being launched as transient, and should go away when the primary app changes.

Typedefs

typedef void(* AlpRelaunchHandler )(int argc, char *argv[], gpointer cbData)
typedef void(* AlpExitHandler )(gpointer cbData)
typedef uint32_t AlpWatcherRef

Enumerations

enum  AlpAppBackgroundingType {
  ALP_APP_BACKGROUND_UNSUPPORTED = 1, ALP_APP_BACKGROUND_SUPPORTED, ALP_APP_BACKGROUND_PREFERRED, ALP_APP_BACKGROUND_REQUIRED,
  ALP_APP_BACKGROUND_DEFAULT = ALP_APP_BACKGROUND_UNSUPPORTED
}
 Values for alp_app_set_backgrounding(); see documentation for backgrounding properties. More...

Functions

alp_status_t alp_app_launch (const char *bundleID, int argc, char *const argv[], pid_t *outPID)
 Sends a request to the appserver to launch the indicated app.
alp_status_t alp_app_launch_async (const char *bundleID, int argc, char *const argv[])
 Sends a request to the appserver to launch the indicated app, without blocking.
alp_status_t alp_app_retire (const char *bundleID)
 Request that the indicated primary application exit or move to the background.
alp_status_t alp_app_exit (const char *bundleID)
 Request that the indicated application cease execution.
alp_status_t alp_app_watcher_add (const char *bundleID, AlpWatcherRef *outWatcherRef, gboolean *outAppRan)
 Add a new watcher to notice when the indicated app is run.
alp_status_t alp_app_watcher_check (AlpWatcherRef watcherRef, gboolean *outAppRan)
 Check if the indicated watcher's target app has been run since the watcher was added.
alp_status_t alp_app_watcher_block (AlpWatcherRef watcherRef, gboolean blockLaunch)
 Configure watcher to (not) prevent its target application from being launched.
alp_status_t alp_app_watcher_remove (AlpWatcherRef watcherRef, gboolean *outAppRan)
 Deallocate the indicated watcher, and check if its target app ran since the watcher was added.
alp_status_t alp_app_current (char **outBundleID)
 Obtain the package ID of the current primary app, if any.
alp_status_t alp_app_set_backgrounding (AlpAppBackgroundingType newBackgrounding)
 Set the application's backgrounding setting.
alp_status_t alp_app_set_relaunch_handler (AlpRelaunchHandler procP, gpointer cbData)
 Set the handler for launch arguments in case the app is launched while it is already running.
alp_status_t alp_app_add_exit_handler (AlpExitHandler procP, gpointer cbData)
 Applications should call this API in order to add an exit handler to the list.
alp_status_t alp_app_remove_exit_handler (AlpExitHandler procP)
 Remove the indicated exit handler from the list.
alp_status_t alp_app_remove_exit_handler_with_data (AlpExitHandler procP, gpointer cbData)
 Remove the indicated exit handler from the list which also matches a given data pointer.
alp_status_t alp_app_theme_update (void)
 Causes all running apps to reload the theme.
alp_status_t alp_app_reset_system (void)
 Causes the system to reboot.


Generated on Sat Dec 16 20:29:48 2006 for hiker-0.9 by  doxygen 1.4.4