installation_proxy.h File Reference

## Description

Manage applications on a device.

## Macros

#define | INSTPROXY_SERVICE_NAME "com.apple.mobile.installation_proxy"
| Service identifier passed to lockdownd_start_service() to start the installation proxy service.

## Typedefs

typedef instproxy_client_private * | instproxy_client_t
| The client handle.
typedef void(* | instproxy_status_cb_t) (plist_t command, plist_t status, void *user_data)
| Reports the status response of the given command.

## Enumerations

enum

instproxy_error_t {
INSTPROXY_E_SUCCESS = 0 ,
INSTPROXY_E_INVALID_ARG = -1 ,
INSTPROXY_E_PLIST_ERROR = -2 ,
INSTPROXY_E_CONN_FAILED = -3 ,
INSTPROXY_E_OP_IN_PROGRESS = -4 ,
INSTPROXY_E_OP_FAILED = -5 ,
INSTPROXY_E_RECEIVE_TIMEOUT = -6 ,
INSTPROXY_E_ALREADY_ARCHIVED = -7 ,
INSTPROXY_E_API_INTERNAL_ERROR = -8 ,
INSTPROXY_E_APPLICATION_ALREADY_INSTALLED = -9 ,
INSTPROXY_E_APPLICATION_MOVE_FAILED = -10 ,
INSTPROXY_E_APPLICATION_SINF_CAPTURE_FAILED = -11 ,
INSTPROXY_E_APPLICATION_SANDBOX_FAILED = -12 ,
INSTPROXY_E_APPLICATION_VERIFICATION_FAILED = -13 ,
INSTPROXY_E_ARCHIVE_DESTRUCTION_FAILED = -14 ,
INSTPROXY_E_BUNDLE_VERIFICATION_FAILED = -15 ,
INSTPROXY_E_CARRIER_BUNDLE_COPY_FAILED = -16 ,
INSTPROXY_E_CARRIER_BUNDLE_DIRECTORY_CREATION_FAILED = -17 ,
INSTPROXY_E_CARRIER_BUNDLE_MISSING_SUPPORTED_SIMS = -18 ,
INSTPROXY_E_COMM_CENTER_NOTIFICATION_FAILED = -19 ,
INSTPROXY_E_CONTAINER_CREATION_FAILED = -20 ,
INSTPROXY_E_CONTAINER_P0WN_FAILED = -21 ,
INSTPROXY_E_CONTAINER_REMOVAL_FAILED = -22 ,
INSTPROXY_E_EMBEDDED_PROFILE_INSTALL_FAILED = -23 ,
INSTPROXY_E_EXECUTABLE_TWIDDLE_FAILED = -24 ,
INSTPROXY_E_EXISTENCE_CHECK_FAILED = -25 ,
INSTPROXY_E_INSTALL_MAP_UPDATE_FAILED = -26 ,
INSTPROXY_E_MANIFEST_CAPTURE_FAILED = -27 ,
INSTPROXY_E_MAP_GENERATION_FAILED = -28 ,
INSTPROXY_E_MISSING_BUNDLE_EXECUTABLE = -29 ,
INSTPROXY_E_MISSING_BUNDLE_IDENTIFIER = -30 ,
INSTPROXY_E_MISSING_BUNDLE_PATH = -31 ,
INSTPROXY_E_MISSING_CONTAINER = -32 ,
INSTPROXY_E_NOTIFICATION_FAILED = -33 ,
INSTPROXY_E_PACKAGE_EXTRACTION_FAILED = -34 ,
INSTPROXY_E_PACKAGE_INSPECTION_FAILED = -35 ,
INSTPROXY_E_PACKAGE_MOVE_FAILED = -36 ,
INSTPROXY_E_PATH_CONVERSION_FAILED = -37 ,
INSTPROXY_E_RESTORE_CONTAINER_FAILED = -38 ,
INSTPROXY_E_SEATBELT_PROFILE_REMOVAL_FAILED = -39 ,
INSTPROXY_E_STAGE_CREATION_FAILED = -40 ,
INSTPROXY_E_SYMLINK_FAILED = -41 ,
INSTPROXY_E_UNKNOWN_COMMAND = -42 ,
INSTPROXY_E_ITUNES_ARTWORK_CAPTURE_FAILED = -43 ,
INSTPROXY_E_ITUNES_METADATA_CAPTURE_FAILED = -44 ,
INSTPROXY_E_DEVICE_OS_VERSION_TOO_LOW = -45 ,
INSTPROXY_E_DEVICE_FAMILY_NOT_SUPPORTED = -46 ,
INSTPROXY_E_PACKAGE_PATCH_FAILED = -47 ,
INSTPROXY_E_INCORRECT_ARCHITECTURE = -48 ,
INSTPROXY_E_PLUGIN_COPY_FAILED = -49 ,
INSTPROXY_E_BREADCRUMB_FAILED = -50 ,
INSTPROXY_E_BREADCRUMB_UNLOCK_FAILED = -51 ,
INSTPROXY_E_GEOJSON_CAPTURE_FAILED = -52 ,
INSTPROXY_E_NEWSSTAND_ARTWORK_CAPTURE_FAILED = -53 ,
INSTPROXY_E_MISSING_COMMAND = -54 ,
INSTPROXY_E_NOT_ENTITLED = -55 ,
INSTPROXY_E_MISSING_PACKAGE_PATH = -56 ,
INSTPROXY_E_MISSING_CONTAINER_PATH = -57 ,
INSTPROXY_E_MISSING_APPLICATION_IDENTIFIER = -58 ,
INSTPROXY_E_MISSING_ATTRIBUTE_VALUE = -59 ,
INSTPROXY_E_LOOKUP_FAILED = -60 ,
INSTPROXY_E_DICT_CREATION_FAILED = -61 ,
INSTPROXY_E_INSTALL_PROHIBITED = -62 ,
INSTPROXY_E_UNINSTALL_PROHIBITED = -63 ,
INSTPROXY_E_MISSING_BUNDLE_VERSION = -64 ,
INSTPROXY_E_UNKNOWN_ERROR = -256
}

| Error Codes.

## Functions

LIBIMOBILEDEVICE_API instproxy_error_t | instproxy_client_new (idevice_t device, lockdownd_service_descriptor_t service, instproxy_client_t *client)
| Connects to the installation_proxy service on the specified device.
LIBIMOBILEDEVICE_API instproxy_error_t | instproxy_client_start_service (idevice_t device, instproxy_client_t *client, const char *label)
| Starts a new installation_proxy service on the specified device and connects to it.
LIBIMOBILEDEVICE_API instproxy_error_t | instproxy_client_free (instproxy_client_t client)
| Disconnects an installation_proxy client from the device and frees up the installation_proxy client data.
LIBIMOBILEDEVICE_API instproxy_error_t | instproxy_browse (instproxy_client_t client, plist_t client_options, plist_t *result)
| List installed applications.
LIBIMOBILEDEVICE_API instproxy_error_t | instproxy_browse_with_callback (instproxy_client_t client, plist_t client_options, instproxy_status_cb_t status_cb, void *user_data)
| List pages of installed applications in a callback.
LIBIMOBILEDEVICE_API instproxy_error_t | instproxy_lookup (instproxy_client_t client, const char **appids, plist_t client_options, plist_t *result)
| Lookup information about specific applications from the device.
LIBIMOBILEDEVICE_API instproxy_error_t | instproxy_install (instproxy_client_t client, const char *pkg_path, plist_t client_options, instproxy_status_cb_t status_cb, void *user_data)
| Install an application on the device.
LIBIMOBILEDEVICE_API instproxy_error_t | instproxy_upgrade (instproxy_client_t client, const char *pkg_path, plist_t client_options, instproxy_status_cb_t status_cb, void *user_data)
| Upgrade an application on the device.
LIBIMOBILEDEVICE_API instproxy_error_t | instproxy_uninstall (instproxy_client_t client, const char *appid, plist_t client_options, instproxy_status_cb_t status_cb, void *user_data)
| Uninstall an application from the device.
LIBIMOBILEDEVICE_API instproxy_error_t | instproxy_lookup_archives (instproxy_client_t client, plist_t client_options, plist_t *result)
| List archived applications.
LIBIMOBILEDEVICE_API instproxy_error_t | instproxy_archive (instproxy_client_t client, const char *appid, plist_t client_options, instproxy_status_cb_t status_cb, void *user_data)
| Archive an application on the device.
LIBIMOBILEDEVICE_API instproxy_error_t | instproxy_restore (instproxy_client_t client, const char *appid, plist_t client_options, instproxy_status_cb_t status_cb, void *user_data)
| Restore a previously archived application on the device.
LIBIMOBILEDEVICE_API instproxy_error_t | instproxy_remove_archive (instproxy_client_t client, const char *appid, plist_t client_options, instproxy_status_cb_t status_cb, void *user_data)
| Removes a previously archived application from the device.
LIBIMOBILEDEVICE_API instproxy_error_t | instproxy_check_capabilities_match (instproxy_client_t client, const char **capabilities, plist_t client_options, plist_t *result)
| Checks a device for certain capabilities.
LIBIMOBILEDEVICE_API void | instproxy_command_get_name (plist_t command, char **name)
| Gets the name from a command dictionary.
LIBIMOBILEDEVICE_API void | instproxy_status_get_name (plist_t status, char **name)
| Gets the name of a status.
LIBIMOBILEDEVICE_API instproxy_error_t | instproxy_status_get_error (plist_t status, char **name, char **description, uint64_t *code)
| Gets error name, code and description from a response if available.
LIBIMOBILEDEVICE_API void | instproxy_status_get_current_list (plist_t status, uint64_t *total, uint64_t *current_index, uint64_t *current_amount, plist_t *list)
| Gets total and current item information from a browse response if available.
LIBIMOBILEDEVICE_API void | instproxy_status_get_percent_complete (plist_t status, int *percent)
| Gets progress in percentage from a status if available.
LIBIMOBILEDEVICE_API plist_t | instproxy_client_options_new (void)
| Creates a new client_options plist.
LIBIMOBILEDEVICE_API void | instproxy_client_options_add (plist_t client_options,...)
| Adds one or more new key:value pairs to the given client_options.
LIBIMOBILEDEVICE_API void | instproxy_client_options_set_return_attributes (plist_t client_options,...)
| Adds attributes to the given client_options to filter browse results.
LIBIMOBILEDEVICE_API void | instproxy_client_options_free (plist_t client_options)
| Frees client_options plist.
LIBIMOBILEDEVICE_API instproxy_error_t | instproxy_client_get_path_for_bundle_identifier (instproxy_client_t client, const char *bundle_id, char **path)
| Queries the device for the path of an application.