libimobiledevice/mobilebackup.h File Reference
MobileBackup Implementation.
More...
Detailed Description
MobileBackup Implementation.
Typedef Documentation
Represents an error code.
Function Documentation
Disconnects a mobilebackup client from the device and frees up the mobilebackup client data.
- Parameters:
-
| client | The mobilebackup client to disconnect and free. |
- Returns:
- MOBILEBACKUP_E_SUCCESS on success, or MOBILEBACKUP_E_INVALID_ARG if client is NULL.
Connects to the mobilebackup service on the specified device.
- Parameters:
-
| device | The device to connect to. |
| port | Destination port (usually given by lockdownd_start_service). |
| client | Pointer that will be set to a newly allocated mobilebackup_client_t upon successful return. |
- Returns:
- MOBILEBACKUP_E_SUCCESS on success, MOBILEBACKUP_E_INVALID ARG if one or more parameters are invalid, or DEVICE_LINK_SERVICE_E_BAD_VERSION if the mobilebackup version on the device is newer.
Polls the device for mobilebackup data.
- Parameters:
-
| client | The mobilebackup client |
| plist | A pointer to the location where the plist should be stored |
- Returns:
- an error code
Request a backup from the connected device.
- Parameters:
-
| client | The connected MobileBackup client to use. |
| backup_manifest | The backup manifest, a plist_t of type PLIST_DICT containing the backup state of the last backup. For a first-time backup set this parameter to NULL. |
| base_path | The base path on the device to use for the backup operation, usually "/". |
| proto_version | A string denoting the version of the backup protocol to use. Latest known version is "1.6" |
- Returns:
- MOBILEBACKUP_E_SUCCESS on success, MOBILEBACKUP_E_INVALID_ARG if one of the parameters is invalid, MOBILEBACKUP_E_PLIST_ERROR if backup_manifest is not of type PLIST_DICT, MOBILEBACKUP_E_MUX_ERROR if a communication error occurs, MOBILEBACKUP_E_REPLY_NOT_OK
Sends mobilebackup data to the device.
- Note:
- This function is low-level and should only be used if you need to send a new type of message.
- Parameters:
-
| client | The mobilebackup client |
| plist | The location of the plist to send |
- Returns:
- an error code
Sends a confirmation to the device that a backup file has been received.
- Parameters:
-
| client | The connected MobileBackup client to use. |
- Returns:
- MOBILEBACKUP_E_SUCCESS on success, MOBILEBACKUP_E_INVALID_ARG if client is invalid, or MOBILEBACKUP_E_MUX_ERROR if a communication error occurs.
Sends a backup error message to the device.
- Parameters:
-
| client | The connected MobileBackup client to use. |
| reason | A string describing the reason for the error message. |
- Returns:
- MOBILEBACKUP_E_SUCCESS on success, MOBILEBACKUP_E_INVALID_ARG if one of the parameters is invalid, or MOBILEBACKUP_E_MUX_ERROR if a communication error occurs.