libimobiledevice/sbservices.h File Reference
Implementation to talk to the SpringBoard services on a device.
More...
Detailed Description
Implementation to talk to the SpringBoard services on a device.
Typedef Documentation
Represents an error code.
Function Documentation
Disconnects an sbservices client from the device and frees up the sbservices client data.
- Parameters:
-
| client | The sbservices client to disconnect and free. |
- Returns:
- SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client is NULL, or an SBSERVICES_E_* error code otherwise.
Connects to the springboardservices 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 point to a newly allocated sbservices_client_t upon successful return. |
- Returns:
- SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client is NULL, or an SBSERVICES_E_* error code otherwise.
Get the icon of the specified app as PNG data.
- Parameters:
-
| client | The connected sbservices client to use. |
| bundleId | The bundle identifier of the app to retrieve the icon for. |
| pngdata | Pointer that will point to a newly allocated buffer containing the PNG data upon successful return. It is up to the caller to free the memory. |
| pngsize | Pointer to a uint64_t that will be set to the size of the buffer pngdata points to upon successful return. |
- Returns:
- SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client, bundleId, or pngdata are invalid, or an SBSERVICES_E_* error code otherwise.
Gets the icon state of the connected device.
- Parameters:
-
| client | The connected sbservices client to use. |
| state | Pointer that will point to a newly allocated plist containing the current icon state. It is up to the caller to free the memory. |
- Returns:
- SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client or state is invalid, or an SBSERVICES_E_* error code otherwise.
Sets the icon state of the connected device.
- Parameters:
-
| client | The connected sbservices client to use. |
| newstate | A plist containing the new iconstate. |
- Returns:
- SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when client or newstate is NULL, or an SBSERVICES_E_* error code otherwise.