summaryrefslogtreecommitdiffstats
path: root/src/sbservices.c
diff options
context:
space:
mode:
authorGravatar Aaron Burghardt2014-03-27 10:07:09 -0400
committerGravatar Aaron Burghardt2014-03-27 21:40:43 -0400
commit2342dc5b4ef148b993fbe3816f3facdef8365546 (patch)
tree69f812d91b2fc07db0fad5dcba6c80d2f8b6849e /src/sbservices.c
parentee82e861a8c942b5013accd7589cf898d1f97167 (diff)
downloadlibimobiledevice-2342dc5b4ef148b993fbe3816f3facdef8365546.tar.gz
libimobiledevice-2342dc5b4ef148b993fbe3816f3facdef8365546.tar.bz2
Moved Doxygen comments from source files to public headers.
Conflicts: include/libimobiledevice/afc.h
Diffstat (limited to 'src/sbservices.c')
-rw-r--r--src/sbservices.c94
1 files changed, 0 insertions, 94 deletions
diff --git a/src/sbservices.c b/src/sbservices.c
index 1d043f1..ea12e35 100644
--- a/src/sbservices.c
+++ b/src/sbservices.c
@@ -76,17 +76,6 @@ static sbservices_error_t sbservices_error(property_list_service_error_t err)
76 return SBSERVICES_E_UNKNOWN_ERROR; 76 return SBSERVICES_E_UNKNOWN_ERROR;
77} 77}
78 78
79/**
80 * Connects to the springboardservices service on the specified device.
81 *
82 * @param device The device to connect to.
83 * @param service The service descriptor returned by lockdownd_start_service.
84 * @param client Pointer that will point to a newly allocated
85 * sbservices_client_t upon successful return.
86 *
87 * @return SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when
88 * client is NULL, or an SBSERVICES_E_* error code otherwise.
89 */
90sbservices_error_t sbservices_client_new(idevice_t device, lockdownd_service_descriptor_t service, sbservices_client_t *client) 79sbservices_error_t sbservices_client_new(idevice_t device, lockdownd_service_descriptor_t service, sbservices_client_t *client)
91{ 80{
92 property_list_service_client_t plistclient = NULL; 81 property_list_service_client_t plistclient = NULL;
@@ -103,19 +92,6 @@ sbservices_error_t sbservices_client_new(idevice_t device, lockdownd_service_des
103 return SBSERVICES_E_SUCCESS; 92 return SBSERVICES_E_SUCCESS;
104} 93}
105 94
106/**
107 * Starts a new sbservices service on the specified device and connects to it.
108 *
109 * @param device The device to connect to.
110 * @param client Pointer that will point to a newly allocated
111 * sbservices_client_t upon successful return. Must be freed using
112 * sbservices_client_free() after use.
113 * @param label The label to use for communication. Usually the program name.
114 * Pass NULL to disable sending the label in requests to lockdownd.
115 *
116 * @return SBSERVICES_E_SUCCESS on success, or an SBSERVICES_E_* error
117 * code otherwise.
118 */
119sbservices_error_t sbservices_client_start_service(idevice_t device, sbservices_client_t * client, const char* label) 95sbservices_error_t sbservices_client_start_service(idevice_t device, sbservices_client_t * client, const char* label)
120{ 96{
121 sbservices_error_t err = SBSERVICES_E_UNKNOWN_ERROR; 97 sbservices_error_t err = SBSERVICES_E_UNKNOWN_ERROR;
@@ -123,15 +99,6 @@ sbservices_error_t sbservices_client_start_service(idevice_t device, sbservices_
123 return err; 99 return err;
124} 100}
125 101
126/**
127 * Disconnects an sbservices client from the device and frees up the
128 * sbservices client data.
129 *
130 * @param client The sbservices client to disconnect and free.
131 *
132 * @return SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when
133 * client is NULL, or an SBSERVICES_E_* error code otherwise.
134 */
135sbservices_error_t sbservices_client_free(sbservices_client_t client) 102sbservices_error_t sbservices_client_free(sbservices_client_t client)
136{ 103{
137 if (!client) 104 if (!client)
@@ -145,20 +112,6 @@ sbservices_error_t sbservices_client_free(sbservices_client_t client)
145 return err; 112 return err;
146} 113}
147 114
148/**
149 * Gets the icon state of the connected device.
150 *
151 * @param client The connected sbservices client to use.
152 * @param state Pointer that will point to a newly allocated plist containing
153 * the current icon state. It is up to the caller to free the memory.
154 * @param format_version A string to be passed as formatVersion along with
155 * the request, or NULL if no formatVersion should be passed. This is only
156 * supported since iOS 4.0 so for older firmware versions this must be set
157 * to NULL.
158 *
159 * @return SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when
160 * client or state is invalid, or an SBSERVICES_E_* error code otherwise.
161 */
162sbservices_error_t sbservices_get_icon_state(sbservices_client_t client, plist_t *state, const char *format_version) 115sbservices_error_t sbservices_get_icon_state(sbservices_client_t client, plist_t *state, const char *format_version)
163{ 116{
164 if (!client || !client->parent || !state) 117 if (!client || !client->parent || !state)
@@ -199,15 +152,6 @@ leave_unlock:
199 return res; 152 return res;
200} 153}
201 154
202/**
203 * Sets the icon state of the connected device.
204 *
205 * @param client The connected sbservices client to use.
206 * @param newstate A plist containing the new iconstate.
207 *
208 * @return SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when
209 * client or newstate is NULL, or an SBSERVICES_E_* error code otherwise.
210 */
211sbservices_error_t sbservices_set_icon_state(sbservices_client_t client, plist_t newstate) 155sbservices_error_t sbservices_set_icon_state(sbservices_client_t client, plist_t newstate)
212{ 156{
213 if (!client || !client->parent || !newstate) 157 if (!client || !client->parent || !newstate)
@@ -234,21 +178,6 @@ sbservices_error_t sbservices_set_icon_state(sbservices_client_t client, plist_t
234 return res; 178 return res;
235} 179}
236 180
237/**
238 * Get the icon of the specified app as PNG data.
239 *
240 * @param client The connected sbservices client to use.
241 * @param bundleId The bundle identifier of the app to retrieve the icon for.
242 * @param pngdata Pointer that will point to a newly allocated buffer
243 * containing the PNG data upon successful return. It is up to the caller
244 * to free the memory.
245 * @param pngsize Pointer to a uint64_t that will be set to the size of the
246 * buffer pngdata points to upon successful return.
247 *
248 * @return SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when
249 * client, bundleId, or pngdata are invalid, or an SBSERVICES_E_* error
250 * code otherwise.
251 */
252sbservices_error_t sbservices_get_icon_pngdata(sbservices_client_t client, const char *bundleId, char **pngdata, uint64_t *pngsize) 181sbservices_error_t sbservices_get_icon_pngdata(sbservices_client_t client, const char *bundleId, char **pngdata, uint64_t *pngsize)
253{ 182{
254 if (!client || !client->parent || !bundleId || !pngdata) 183 if (!client || !client->parent || !bundleId || !pngdata)
@@ -286,15 +215,6 @@ leave_unlock:
286 return res; 215 return res;
287} 216}
288 217
289/**
290 * Gets the interface orientation of the device.
291 *
292 * @param client The connected sbservices client to use.
293 * @param interface_orientation The interface orientation upon successful return.
294 *
295 * @return SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when
296 * client or state is invalid, or an SBSERVICES_E_* error code otherwise.
297 */
298sbservices_error_t sbservices_get_interface_orientation(sbservices_client_t client, sbservices_interface_orientation_t* interface_orientation) 218sbservices_error_t sbservices_get_interface_orientation(sbservices_client_t client, sbservices_interface_orientation_t* interface_orientation)
299{ 219{
300 if (!client || !client->parent || !interface_orientation) 220 if (!client || !client->parent || !interface_orientation)
@@ -333,20 +253,6 @@ leave_unlock:
333 return res; 253 return res;
334} 254}
335 255
336/**
337 * Get the home screen wallpaper as PNG data.
338 *
339 * @param client The connected sbservices client to use.
340 * @param pngdata Pointer that will point to a newly allocated buffer
341 * containing the PNG data upon successful return. It is up to the caller
342 * to free the memory.
343 * @param pngsize Pointer to a uint64_t that will be set to the size of the
344 * buffer pngdata points to upon successful return.
345 *
346 * @return SBSERVICES_E_SUCCESS on success, SBSERVICES_E_INVALID_ARG when
347 * client or pngdata are invalid, or an SBSERVICES_E_* error
348 * code otherwise.
349 */
350sbservices_error_t sbservices_get_home_screen_wallpaper_pngdata(sbservices_client_t client, char **pngdata, uint64_t *pngsize) 256sbservices_error_t sbservices_get_home_screen_wallpaper_pngdata(sbservices_client_t client, char **pngdata, uint64_t *pngsize)
351{ 257{
352 if (!client || !client->parent || !pngdata) 258 if (!client || !client->parent || !pngdata)