diff options
Diffstat (limited to 'include/libimobiledevice/installation_proxy.h')
| -rw-r--r-- | include/libimobiledevice/installation_proxy.h | 48 | 
1 files changed, 24 insertions, 24 deletions
| diff --git a/include/libimobiledevice/installation_proxy.h b/include/libimobiledevice/installation_proxy.h index 87132b9..44331aa 100644 --- a/include/libimobiledevice/installation_proxy.h +++ b/include/libimobiledevice/installation_proxy.h | |||
| @@ -127,7 +127,7 @@ typedef void (*instproxy_status_cb_t) (plist_t command, plist_t status, void *us | |||
| 127 | * @return INSTPROXY_E_SUCCESS on success, or an INSTPROXY_E_* error value | 127 | * @return INSTPROXY_E_SUCCESS on success, or an INSTPROXY_E_* error value | 
| 128 | * when an error occurred. | 128 | * when an error occurred. | 
| 129 | */ | 129 | */ | 
| 130 | instproxy_error_t instproxy_client_new(idevice_t device, lockdownd_service_descriptor_t service, instproxy_client_t *client); | 130 | LIBIMOBILEDEVICE_API instproxy_error_t instproxy_client_new(idevice_t device, lockdownd_service_descriptor_t service, instproxy_client_t *client); | 
| 131 | 131 | ||
| 132 | /** | 132 | /** | 
| 133 | * Starts a new installation_proxy service on the specified device and connects to it. | 133 | * Starts a new installation_proxy service on the specified device and connects to it. | 
| @@ -142,7 +142,7 @@ instproxy_error_t instproxy_client_new(idevice_t device, lockdownd_service_descr | |||
| 142 | * @return INSTPROXY_E_SUCCESS on success, or an INSTPROXY_E_* error | 142 | * @return INSTPROXY_E_SUCCESS on success, or an INSTPROXY_E_* error | 
| 143 | * code otherwise. | 143 | * code otherwise. | 
| 144 | */ | 144 | */ | 
| 145 | instproxy_error_t instproxy_client_start_service(idevice_t device, instproxy_client_t * client, const char* label); | 145 | LIBIMOBILEDEVICE_API instproxy_error_t instproxy_client_start_service(idevice_t device, instproxy_client_t * client, const char* label); | 
| 146 | 146 | ||
| 147 | /** | 147 | /** | 
| 148 | * Disconnects an installation_proxy client from the device and frees up the | 148 | * Disconnects an installation_proxy client from the device and frees up the | 
| @@ -153,7 +153,7 @@ instproxy_error_t instproxy_client_start_service(idevice_t device, instproxy_cli | |||
| 153 | * @return INSTPROXY_E_SUCCESS on success | 153 | * @return INSTPROXY_E_SUCCESS on success | 
| 154 | * or INSTPROXY_E_INVALID_ARG if client is NULL. | 154 | * or INSTPROXY_E_INVALID_ARG if client is NULL. | 
| 155 | */ | 155 | */ | 
| 156 | instproxy_error_t instproxy_client_free(instproxy_client_t client); | 156 | LIBIMOBILEDEVICE_API instproxy_error_t instproxy_client_free(instproxy_client_t client); | 
| 157 | 157 | ||
| 158 | /** | 158 | /** | 
| 159 | * List installed applications. This function runs synchronously. | 159 | * List installed applications. This function runs synchronously. | 
| @@ -171,7 +171,7 @@ instproxy_error_t instproxy_client_free(instproxy_client_t client); | |||
| 171 | * @return INSTPROXY_E_SUCCESS on success or an INSTPROXY_E_* error value if | 171 | * @return INSTPROXY_E_SUCCESS on success or an INSTPROXY_E_* error value if | 
| 172 | * an error occurred. | 172 | * an error occurred. | 
| 173 | */ | 173 | */ | 
| 174 | instproxy_error_t instproxy_browse(instproxy_client_t client, plist_t client_options, plist_t *result); | 174 | LIBIMOBILEDEVICE_API instproxy_error_t instproxy_browse(instproxy_client_t client, plist_t client_options, plist_t *result); | 
| 175 | 175 | ||
| 176 | /** | 176 | /** | 
| 177 | * List pages of installed applications in a callback. | 177 | * List pages of installed applications in a callback. | 
| @@ -190,7 +190,7 @@ instproxy_error_t instproxy_browse(instproxy_client_t client, plist_t client_opt | |||
| 190 | * @return INSTPROXY_E_SUCCESS on success or an INSTPROXY_E_* error value if | 190 | * @return INSTPROXY_E_SUCCESS on success or an INSTPROXY_E_* error value if | 
| 191 | * an error occurred. | 191 | * an error occurred. | 
| 192 | */ | 192 | */ | 
| 193 | instproxy_error_t instproxy_browse_with_callback(instproxy_client_t client, plist_t client_options, instproxy_status_cb_t status_cb, void *user_data); | 193 | 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); | 
| 194 | 194 | ||
| 195 | /** | 195 | /** | 
| 196 | * Lookup information about specific applications from the device. | 196 | * Lookup information about specific applications from the device. | 
| @@ -206,7 +206,7 @@ instproxy_error_t instproxy_browse_with_callback(instproxy_client_t client, plis | |||
| 206 | * @return INSTPROXY_E_SUCCESS on success or an INSTPROXY_E_* error value if | 206 | * @return INSTPROXY_E_SUCCESS on success or an INSTPROXY_E_* error value if | 
| 207 | * an error occurred. | 207 | * an error occurred. | 
| 208 | */ | 208 | */ | 
| 209 | instproxy_error_t instproxy_lookup(instproxy_client_t client, const char** appids, plist_t client_options, plist_t *result); | 209 | LIBIMOBILEDEVICE_API instproxy_error_t instproxy_lookup(instproxy_client_t client, const char** appids, plist_t client_options, plist_t *result); | 
| 210 | 210 | ||
| 211 | /** | 211 | /** | 
| 212 | * Install an application on the device. | 212 | * Install an application on the device. | 
| @@ -232,7 +232,7 @@ instproxy_error_t instproxy_lookup(instproxy_client_t client, const char** appid | |||
| 232 | * created successfully; any error occurring during the command has to be | 232 | * created successfully; any error occurring during the command has to be | 
| 233 | * handled inside the specified callback function. | 233 | * handled inside the specified callback function. | 
| 234 | */ | 234 | */ | 
| 235 | 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); | 235 | 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); | 
| 236 | 236 | ||
| 237 | /** | 237 | /** | 
| 238 | * Upgrade an application on the device. This function is nearly the same as | 238 | * Upgrade an application on the device. This function is nearly the same as | 
| @@ -260,7 +260,7 @@ instproxy_error_t instproxy_install(instproxy_client_t client, const char *pkg_p | |||
| 260 | * created successfully; any error occurring during the command has to be | 260 | * created successfully; any error occurring during the command has to be | 
| 261 | * handled inside the specified callback function. | 261 | * handled inside the specified callback function. | 
| 262 | */ | 262 | */ | 
| 263 | 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); | 263 | 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); | 
| 264 | 264 | ||
| 265 | /** | 265 | /** | 
| 266 | * Uninstall an application from the device. | 266 | * Uninstall an application from the device. | 
| @@ -281,7 +281,7 @@ instproxy_error_t instproxy_upgrade(instproxy_client_t client, const char *pkg_p | |||
| 281 | * created successfully; any error occurring during the command has to be | 281 | * created successfully; any error occurring during the command has to be | 
| 282 | * handled inside the specified callback function. | 282 | * handled inside the specified callback function. | 
| 283 | */ | 283 | */ | 
| 284 | 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); | 284 | 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); | 
| 285 | 285 | ||
| 286 | /** | 286 | /** | 
| 287 | * List archived applications. This function runs synchronously. | 287 | * List archived applications. This function runs synchronously. | 
| @@ -297,7 +297,7 @@ instproxy_error_t instproxy_uninstall(instproxy_client_t client, const char *app | |||
| 297 | * @return INSTPROXY_E_SUCCESS on success or an INSTPROXY_E_* error value if | 297 | * @return INSTPROXY_E_SUCCESS on success or an INSTPROXY_E_* error value if | 
| 298 | * an error occurred. | 298 | * an error occurred. | 
| 299 | */ | 299 | */ | 
| 300 | instproxy_error_t instproxy_lookup_archives(instproxy_client_t client, plist_t client_options, plist_t *result); | 300 | LIBIMOBILEDEVICE_API instproxy_error_t instproxy_lookup_archives(instproxy_client_t client, plist_t client_options, plist_t *result); | 
| 301 | 301 | ||
| 302 | /** | 302 | /** | 
| 303 | * Archive an application on the device. | 303 | * Archive an application on the device. | 
| @@ -323,7 +323,7 @@ instproxy_error_t instproxy_lookup_archives(instproxy_client_t client, plist_t c | |||
| 323 | * created successfully; any error occurring during the command has to be | 323 | * created successfully; any error occurring during the command has to be | 
| 324 | * handled inside the specified callback function. | 324 | * handled inside the specified callback function. | 
| 325 | */ | 325 | */ | 
| 326 | 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); | 326 | 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); | 
| 327 | 327 | ||
| 328 | /** | 328 | /** | 
| 329 | * Restore a previously archived application on the device. | 329 | * Restore a previously archived application on the device. | 
| @@ -347,7 +347,7 @@ instproxy_error_t instproxy_archive(instproxy_client_t client, const char *appid | |||
| 347 | * created successfully; any error occurring during the command has to be | 347 | * created successfully; any error occurring during the command has to be | 
| 348 | * handled inside the specified callback function. | 348 | * handled inside the specified callback function. | 
| 349 | */ | 349 | */ | 
| 350 | 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); | 350 | 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); | 
| 351 | 351 | ||
| 352 | /** | 352 | /** | 
| 353 | * Removes a previously archived application from the device. | 353 | * Removes a previously archived application from the device. | 
| @@ -370,7 +370,7 @@ instproxy_error_t instproxy_restore(instproxy_client_t client, const char *appid | |||
| 370 | * created successfully; any error occurring during the command has to be | 370 | * created successfully; any error occurring during the command has to be | 
| 371 | * handled inside the specified callback function. | 371 | * handled inside the specified callback function. | 
| 372 | */ | 372 | */ | 
| 373 | 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); | 373 | 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); | 
| 374 | 374 | ||
| 375 | /** | 375 | /** | 
| 376 | * Checks a device for certain capabilities. | 376 | * Checks a device for certain capabilities. | 
| @@ -386,7 +386,7 @@ instproxy_error_t instproxy_remove_archive(instproxy_client_t client, const char | |||
| 386 | * @return INSTPROXY_E_SUCCESS on success or an INSTPROXY_E_* error value if | 386 | * @return INSTPROXY_E_SUCCESS on success or an INSTPROXY_E_* error value if | 
| 387 | * an error occurred. | 387 | * an error occurred. | 
| 388 | */ | 388 | */ | 
| 389 | instproxy_error_t instproxy_check_capabilities_match(instproxy_client_t client, const char** capabilities, plist_t client_options, plist_t *result); | 389 | LIBIMOBILEDEVICE_API instproxy_error_t instproxy_check_capabilities_match(instproxy_client_t client, const char** capabilities, plist_t client_options, plist_t *result); | 
| 390 | 390 | ||
| 391 | /* Helper */ | 391 | /* Helper */ | 
| 392 | 392 | ||
| @@ -396,7 +396,7 @@ instproxy_error_t instproxy_check_capabilities_match(instproxy_client_t client, | |||
| 396 | * @param command The dictionary describing the command. | 396 | * @param command The dictionary describing the command. | 
| 397 | * @param name Pointer to store the name of the command. | 397 | * @param name Pointer to store the name of the command. | 
| 398 | */ | 398 | */ | 
| 399 | void instproxy_command_get_name(plist_t command, char** name); | 399 | LIBIMOBILEDEVICE_API void instproxy_command_get_name(plist_t command, char** name); | 
| 400 | 400 | ||
| 401 | /** | 401 | /** | 
| 402 | * Gets the name of a status. | 402 | * Gets the name of a status. | 
| @@ -404,7 +404,7 @@ void instproxy_command_get_name(plist_t command, char** name); | |||
| 404 | * @param status The dictionary status response to use. | 404 | * @param status The dictionary status response to use. | 
| 405 | * @param name Pointer to store the name of the status. | 405 | * @param name Pointer to store the name of the status. | 
| 406 | */ | 406 | */ | 
| 407 | void instproxy_status_get_name(plist_t status, char **name); | 407 | LIBIMOBILEDEVICE_API void instproxy_status_get_name(plist_t status, char **name); | 
| 408 | 408 | ||
| 409 | /** | 409 | /** | 
| 410 | * Gets error name, code and description from a response if available. | 410 | * Gets error name, code and description from a response if available. | 
| @@ -420,7 +420,7 @@ void instproxy_status_get_name(plist_t status, char **name); | |||
| 420 | * @return INSTPROXY_E_SUCCESS if no error is found or an INSTPROXY_E_* error | 420 | * @return INSTPROXY_E_SUCCESS if no error is found or an INSTPROXY_E_* error | 
| 421 | * value matching the error that ẃas found in the status. | 421 | * value matching the error that ẃas found in the status. | 
| 422 | */ | 422 | */ | 
| 423 | instproxy_error_t instproxy_status_get_error(plist_t status, char **name, char** description, uint64_t* code); | 423 | LIBIMOBILEDEVICE_API instproxy_error_t instproxy_status_get_error(plist_t status, char **name, char** description, uint64_t* code); | 
| 424 | 424 | ||
| 425 | /** | 425 | /** | 
| 426 | * Gets total and current item information from a browse response if available. | 426 | * Gets total and current item information from a browse response if available. | 
| @@ -435,7 +435,7 @@ instproxy_error_t instproxy_status_get_error(plist_t status, char **name, char** | |||
| 435 | * If NULL is passed no list will be returned. If NULL is returned no | 435 | * If NULL is passed no list will be returned. If NULL is returned no | 
| 436 | * list was found in the status. | 436 | * list was found in the status. | 
| 437 | */ | 437 | */ | 
| 438 | void instproxy_status_get_current_list(plist_t status, uint64_t* total, uint64_t* current_index, uint64_t* current_amount, plist_t* list); | 438 | 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); | 
| 439 | 439 | ||
| 440 | 440 | ||
| 441 | /** | 441 | /** | 
| @@ -445,14 +445,14 @@ void instproxy_status_get_current_list(plist_t status, uint64_t* total, uint64_t | |||
| 445 | * @param percent Pointer to an int to store the progress in percent (0-100) | 445 | * @param percent Pointer to an int to store the progress in percent (0-100) | 
| 446 | * or -1 if no progress was found in the status. | 446 | * or -1 if no progress was found in the status. | 
| 447 | */ | 447 | */ | 
| 448 | void instproxy_status_get_percent_complete(plist_t status, int *percent); | 448 | LIBIMOBILEDEVICE_API void instproxy_status_get_percent_complete(plist_t status, int *percent); | 
| 449 | 449 | ||
| 450 | /** | 450 | /** | 
| 451 | * Creates a new client_options plist. | 451 | * Creates a new client_options plist. | 
| 452 | * | 452 | * | 
| 453 | * @return A new plist_t of type PLIST_DICT. | 453 | * @return A new plist_t of type PLIST_DICT. | 
| 454 | */ | 454 | */ | 
| 455 | plist_t instproxy_client_options_new(void); | 455 | LIBIMOBILEDEVICE_API plist_t instproxy_client_options_new(void); | 
| 456 | 456 | ||
| 457 | /** | 457 | /** | 
| 458 | * Adds one or more new key:value pairs to the given client_options. | 458 | * Adds one or more new key:value pairs to the given client_options. | 
| @@ -464,7 +464,7 @@ plist_t instproxy_client_options_new(void); | |||
| 464 | * keys "ApplicationSINF", "iTunesMetadata", "ReturnAttributes" which are | 464 | * keys "ApplicationSINF", "iTunesMetadata", "ReturnAttributes" which are | 
| 465 | * expecting a plist_t node as value and "SkipUninstall" expects int. | 465 | * expecting a plist_t node as value and "SkipUninstall" expects int. | 
| 466 | */ | 466 | */ | 
| 467 | void instproxy_client_options_add(plist_t client_options, ...); | 467 | LIBIMOBILEDEVICE_API void instproxy_client_options_add(plist_t client_options, ...); | 
| 468 | 468 | ||
| 469 | /** | 469 | /** | 
| 470 | * Adds attributes to the given client_options to filter browse results. | 470 | * Adds attributes to the given client_options to filter browse results. | 
| @@ -474,7 +474,7 @@ void instproxy_client_options_add(plist_t client_options, ...); | |||
| 474 | * | 474 | * | 
| 475 | * @note The values passed are expected to be strings. | 475 | * @note The values passed are expected to be strings. | 
| 476 | */ | 476 | */ | 
| 477 | void instproxy_client_options_set_return_attributes(plist_t client_options, ...); | 477 | LIBIMOBILEDEVICE_API void instproxy_client_options_set_return_attributes(plist_t client_options, ...); | 
| 478 | 478 | ||
| 479 | /** | 479 | /** | 
| 480 | * Frees client_options plist. | 480 | * Frees client_options plist. | 
| @@ -482,7 +482,7 @@ void instproxy_client_options_set_return_attributes(plist_t client_options, ...) | |||
| 482 | * @param client_options The client options plist to free. Does nothing if NULL | 482 | * @param client_options The client options plist to free. Does nothing if NULL | 
| 483 | * is passed. | 483 | * is passed. | 
| 484 | */ | 484 | */ | 
| 485 | void instproxy_client_options_free(plist_t client_options); | 485 | LIBIMOBILEDEVICE_API void instproxy_client_options_free(plist_t client_options); | 
| 486 | 486 | ||
| 487 | /** | 487 | /** | 
| 488 | * Queries the device for the path of an application. | 488 | * Queries the device for the path of an application. | 
| @@ -496,7 +496,7 @@ void instproxy_client_options_free(plist_t client_options); | |||
| 496 | * the path could not be determined or an INSTPROXY_E_* error | 496 | * the path could not be determined or an INSTPROXY_E_* error | 
| 497 | * value if an error occurred. | 497 | * value if an error occurred. | 
| 498 | */ | 498 | */ | 
| 499 | instproxy_error_t instproxy_client_get_path_for_bundle_identifier(instproxy_client_t client, const char* bundle_id, char** path); | 499 | LIBIMOBILEDEVICE_API instproxy_error_t instproxy_client_get_path_for_bundle_identifier(instproxy_client_t client, const char* bundle_id, char** path); | 
| 500 | 500 | ||
| 501 | #ifdef __cplusplus | 501 | #ifdef __cplusplus | 
| 502 | } | 502 | } | 
