| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057 |
- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
- <meta http-equiv="X-UA-Compatible" content="IE=9"/>
- <meta name="generator" content="Doxygen 1.8.8"/>
- <title>libimobiledevice: libimobiledevice/mobilesync.h File Reference</title>
- <link href="tabs.css" rel="stylesheet" type="text/css"/>
- <script type="text/javascript" src="jquery.js"></script>
- <script type="text/javascript" src="dynsections.js"></script>
- <link href="doxygen.css" rel="stylesheet" type="text/css" />
- </head>
- <body>
- <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
- <div id="titlearea">
- <table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td style="padding-left: 0.5em;">
- <div id="projectname">libimobiledevice
-  <span id="projectnumber">1.2.0</span>
- </div>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <!-- end header part -->
- <!-- Generated by Doxygen 1.8.8 -->
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="annotated.html"><span>Data Structures</span></a></li>
- <li class="current"><a href="files.html"><span>Files</span></a></li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="files.html"><span>File List</span></a></li>
- <li><a href="globals.html"><span>Globals</span></a></li>
- </ul>
- </div>
- <div id="nav-path" class="navpath">
- <ul>
- <li class="navelem"><a class="el" href="dir_6f94c0669708509ba6e66291c679659c.html">libimobiledevice</a></li> </ul>
- </div>
- </div><!-- top -->
- <div class="header">
- <div class="summary">
- <a href="#nested-classes">Data Structures</a> |
- <a href="#define-members">Macros</a> |
- <a href="#typedef-members">Typedefs</a> |
- <a href="#enum-members">Enumerations</a> |
- <a href="#func-members">Functions</a> </div>
- <div class="headertitle">
- <div class="title">mobilesync.h File Reference</div> </div>
- </div><!--header-->
- <div class="contents">
- <p>Synchronize data classes with a device and computer.
- <a href="#details">More...</a></p>
- <table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
- Data Structures</h2></td></tr>
- <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structmobilesync__anchors.html">mobilesync_anchors</a></td></tr>
- <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
- Macros</h2></td></tr>
- <tr class="memitem:a26c379c114c7332a376d91dd638ed1b5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26c379c114c7332a376d91dd638ed1b5"></a>
- #define </td><td class="memItemRight" valign="bottom"><b>MOBILESYNC_SERVICE_NAME</b>   "com.apple.mobilesync"</td></tr>
- <tr class="separator:a26c379c114c7332a376d91dd638ed1b5"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
- Typedefs</h2></td></tr>
- <tr class="memitem:afa93d58774a9b6fa86a2ca8cbfcf287e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="afa93d58774a9b6fa86a2ca8cbfcf287e"></a>
- typedef struct <br class="typebreak" />
- mobilesync_client_private </td><td class="memItemRight" valign="bottom"><b>mobilesync_client_private</b></td></tr>
- <tr class="separator:afa93d58774a9b6fa86a2ca8cbfcf287e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ae9416410eb63a6f40c144f5e13576650"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9416410eb63a6f40c144f5e13576650"></a>
- typedef mobilesync_client_private * </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a></td></tr>
- <tr class="memdesc:ae9416410eb63a6f40c144f5e13576650"><td class="mdescLeft"> </td><td class="mdescRight">The client handle. <br /></td></tr>
- <tr class="separator:ae9416410eb63a6f40c144f5e13576650"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8c58f99e22c6fa4ad18073d31f71cb3b"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="structmobilesync__anchors.html">mobilesync_anchors</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#a8c58f99e22c6fa4ad18073d31f71cb3b">mobilesync_anchors_t</a></td></tr>
- <tr class="memdesc:a8c58f99e22c6fa4ad18073d31f71cb3b"><td class="mdescLeft"> </td><td class="mdescRight">Anchors used by the device and computer. <a href="#a8c58f99e22c6fa4ad18073d31f71cb3b">More...</a><br /></td></tr>
- <tr class="separator:a8c58f99e22c6fa4ad18073d31f71cb3b"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
- Enumerations</h2></td></tr>
- <tr class="memitem:a11a123e7523156d4fc7d455f0a345eeb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a11a123e7523156d4fc7d455f0a345eeb"></a>enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> { <br />
-   <b>MOBILESYNC_E_SUCCESS</b> = 0,
- <br />
-   <b>MOBILESYNC_E_INVALID_ARG</b> = -1,
- <br />
-   <b>MOBILESYNC_E_PLIST_ERROR</b> = -2,
- <br />
-   <b>MOBILESYNC_E_MUX_ERROR</b> = -3,
- <br />
-   <b>MOBILESYNC_E_BAD_VERSION</b> = -4,
- <br />
-   <b>MOBILESYNC_E_SYNC_REFUSED</b> = -5,
- <br />
-   <b>MOBILESYNC_E_CANCELLED</b> = -6,
- <br />
-   <b>MOBILESYNC_E_WRONG_DIRECTION</b> = -7,
- <br />
-   <b>MOBILESYNC_E_NOT_READY</b> = -8,
- <br />
-   <b>MOBILESYNC_E_UNKNOWN_ERROR</b> = -256
- <br />
- }</td></tr>
- <tr class="memdesc:a11a123e7523156d4fc7d455f0a345eeb"><td class="mdescLeft"> </td><td class="mdescRight">Error Codes. <br /></td></tr>
- <tr class="separator:a11a123e7523156d4fc7d455f0a345eeb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac9f9e31e087d8a816ddb4aeed1eea80c"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#ac9f9e31e087d8a816ddb4aeed1eea80c">mobilesync_sync_type_t</a> { <br />
-   <a class="el" href="mobilesync_8h.html#ac9f9e31e087d8a816ddb4aeed1eea80cae0430179c44c50bef80b51f990eee230">MOBILESYNC_SYNC_TYPE_FAST</a>,
- <br />
-   <a class="el" href="mobilesync_8h.html#ac9f9e31e087d8a816ddb4aeed1eea80caeffffd3b2f288fad21820cd403780100">MOBILESYNC_SYNC_TYPE_SLOW</a>,
- <br />
-   <a class="el" href="mobilesync_8h.html#ac9f9e31e087d8a816ddb4aeed1eea80ca8327459ac3c534d30050e76cd30f95c1">MOBILESYNC_SYNC_TYPE_RESET</a>
- <br />
- }</td></tr>
- <tr class="memdesc:ac9f9e31e087d8a816ddb4aeed1eea80c"><td class="mdescLeft"> </td><td class="mdescRight">The sync type of the current sync session. <a href="mobilesync_8h.html#ac9f9e31e087d8a816ddb4aeed1eea80c">More...</a><br /></td></tr>
- <tr class="separator:ac9f9e31e087d8a816ddb4aeed1eea80c"><td class="memSeparator" colspan="2"> </td></tr>
- </table><table class="memberdecls">
- <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
- Functions</h2></td></tr>
- <tr class="memitem:a58d7d7755eefd092f029834392deddc8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#a58d7d7755eefd092f029834392deddc8">mobilesync_client_new</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, lockdownd_service_descriptor_t service, <a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> *client)</td></tr>
- <tr class="memdesc:a58d7d7755eefd092f029834392deddc8"><td class="mdescLeft"> </td><td class="mdescRight">Connects to the mobilesync service on the specified device. <a href="#a58d7d7755eefd092f029834392deddc8">More...</a><br /></td></tr>
- <tr class="separator:a58d7d7755eefd092f029834392deddc8"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a42644361b6d783f04d00eed29f05d314"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#a42644361b6d783f04d00eed29f05d314">mobilesync_client_start_service</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, <a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> *client, const char *label)</td></tr>
- <tr class="memdesc:a42644361b6d783f04d00eed29f05d314"><td class="mdescLeft"> </td><td class="mdescRight">Starts a new mobilesync service on the specified device and connects to it. <a href="#a42644361b6d783f04d00eed29f05d314">More...</a><br /></td></tr>
- <tr class="separator:a42644361b6d783f04d00eed29f05d314"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a684e78bdb59be1169217f3e9d7fbc2da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#a684e78bdb59be1169217f3e9d7fbc2da">mobilesync_client_free</a> (<a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> client)</td></tr>
- <tr class="memdesc:a684e78bdb59be1169217f3e9d7fbc2da"><td class="mdescLeft"> </td><td class="mdescRight">Disconnects a mobilesync client from the device and frees up the mobilesync client data. <a href="#a684e78bdb59be1169217f3e9d7fbc2da">More...</a><br /></td></tr>
- <tr class="separator:a684e78bdb59be1169217f3e9d7fbc2da"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a85d593631f8dddd7f58691c7351a1f44"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#a85d593631f8dddd7f58691c7351a1f44">mobilesync_receive</a> (<a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> client, plist_t *plist)</td></tr>
- <tr class="memdesc:a85d593631f8dddd7f58691c7351a1f44"><td class="mdescLeft"> </td><td class="mdescRight">Polls the device for mobilesync data. <a href="#a85d593631f8dddd7f58691c7351a1f44">More...</a><br /></td></tr>
- <tr class="separator:a85d593631f8dddd7f58691c7351a1f44"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a76e54260a77572f07327cbc17d805533"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#a76e54260a77572f07327cbc17d805533">mobilesync_send</a> (<a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> client, plist_t plist)</td></tr>
- <tr class="memdesc:a76e54260a77572f07327cbc17d805533"><td class="mdescLeft"> </td><td class="mdescRight">Sends mobilesync data to the device. <a href="#a76e54260a77572f07327cbc17d805533">More...</a><br /></td></tr>
- <tr class="separator:a76e54260a77572f07327cbc17d805533"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a02d0232ec6986ef27a9a02d6a877d865"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#a02d0232ec6986ef27a9a02d6a877d865">mobilesync_start</a> (<a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> client, const char *data_class, <a class="el" href="mobilesync_8h.html#a8c58f99e22c6fa4ad18073d31f71cb3b">mobilesync_anchors_t</a> anchors, uint64_t computer_data_class_version, <a class="el" href="mobilesync_8h.html#ac9f9e31e087d8a816ddb4aeed1eea80c">mobilesync_sync_type_t</a> *sync_type, uint64_t *device_data_class_version, char **error_description)</td></tr>
- <tr class="memdesc:a02d0232ec6986ef27a9a02d6a877d865"><td class="mdescLeft"> </td><td class="mdescRight">Requests starting synchronization of a data class with the device. <a href="#a02d0232ec6986ef27a9a02d6a877d865">More...</a><br /></td></tr>
- <tr class="separator:a02d0232ec6986ef27a9a02d6a877d865"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afdabe2be886c047027bf059e337339fd"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#afdabe2be886c047027bf059e337339fd">mobilesync_cancel</a> (<a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> client, const char *reason)</td></tr>
- <tr class="memdesc:afdabe2be886c047027bf059e337339fd"><td class="mdescLeft"> </td><td class="mdescRight">Cancels a running synchronization session with a device at any time. <a href="#afdabe2be886c047027bf059e337339fd">More...</a><br /></td></tr>
- <tr class="separator:afdabe2be886c047027bf059e337339fd"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a2b6d0acc51dc8a1e9064c79c54cdbcea"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#a2b6d0acc51dc8a1e9064c79c54cdbcea">mobilesync_finish</a> (<a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> client)</td></tr>
- <tr class="memdesc:a2b6d0acc51dc8a1e9064c79c54cdbcea"><td class="mdescLeft"> </td><td class="mdescRight">Finish a synchronization session of a data class on the device. <a href="#a2b6d0acc51dc8a1e9064c79c54cdbcea">More...</a><br /></td></tr>
- <tr class="separator:a2b6d0acc51dc8a1e9064c79c54cdbcea"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ab5c816504e565b9f391a7b1692667e7b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#ab5c816504e565b9f391a7b1692667e7b">mobilesync_get_all_records_from_device</a> (<a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> client)</td></tr>
- <tr class="memdesc:ab5c816504e565b9f391a7b1692667e7b"><td class="mdescLeft"> </td><td class="mdescRight">Requests to receive all records of the currently set data class from the device. <a href="#ab5c816504e565b9f391a7b1692667e7b">More...</a><br /></td></tr>
- <tr class="separator:ab5c816504e565b9f391a7b1692667e7b"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a96b9227e7e8d6602329b4c10d99ce9bb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#a96b9227e7e8d6602329b4c10d99ce9bb">mobilesync_get_changes_from_device</a> (<a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> client)</td></tr>
- <tr class="memdesc:a96b9227e7e8d6602329b4c10d99ce9bb"><td class="mdescLeft"> </td><td class="mdescRight">Requests to receive only changed records of the currently set data class from the device. <a href="#a96b9227e7e8d6602329b4c10d99ce9bb">More...</a><br /></td></tr>
- <tr class="separator:a96b9227e7e8d6602329b4c10d99ce9bb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:adcb1b94b5dcbc58c2a4f34339f64f253"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#adcb1b94b5dcbc58c2a4f34339f64f253">mobilesync_clear_all_records_on_device</a> (<a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> client)</td></tr>
- <tr class="memdesc:adcb1b94b5dcbc58c2a4f34339f64f253"><td class="mdescLeft"> </td><td class="mdescRight">Requests the device to delete all records of the current data class. <a href="#adcb1b94b5dcbc58c2a4f34339f64f253">More...</a><br /></td></tr>
- <tr class="separator:adcb1b94b5dcbc58c2a4f34339f64f253"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:aad274556b5e793d0d4ebd83dbef8f20e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#aad274556b5e793d0d4ebd83dbef8f20e">mobilesync_receive_changes</a> (<a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> client, plist_t *entities, uint8_t *is_last_record, plist_t *actions)</td></tr>
- <tr class="memdesc:aad274556b5e793d0d4ebd83dbef8f20e"><td class="mdescLeft"> </td><td class="mdescRight">Receives changed entitites of the currently set data class from the device. <a href="#aad274556b5e793d0d4ebd83dbef8f20e">More...</a><br /></td></tr>
- <tr class="separator:aad274556b5e793d0d4ebd83dbef8f20e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8e93751ac8f9cd584b16b946b7618abf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#a8e93751ac8f9cd584b16b946b7618abf">mobilesync_acknowledge_changes_from_device</a> (<a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> client)</td></tr>
- <tr class="memdesc:a8e93751ac8f9cd584b16b946b7618abf"><td class="mdescLeft"> </td><td class="mdescRight">Acknowledges to the device that the changes have been merged on the computer. <a href="#a8e93751ac8f9cd584b16b946b7618abf">More...</a><br /></td></tr>
- <tr class="separator:a8e93751ac8f9cd584b16b946b7618abf"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a19bca33f057c33d0487ac1947beaeceb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#a19bca33f057c33d0487ac1947beaeceb">mobilesync_ready_to_send_changes_from_computer</a> (<a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> client)</td></tr>
- <tr class="memdesc:a19bca33f057c33d0487ac1947beaeceb"><td class="mdescLeft"> </td><td class="mdescRight">Verifies if the device is ready to receive changes from the computer. <a href="#a19bca33f057c33d0487ac1947beaeceb">More...</a><br /></td></tr>
- <tr class="separator:a19bca33f057c33d0487ac1947beaeceb"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a9d27a8141804c3527af0ea54c2d1976a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#a9d27a8141804c3527af0ea54c2d1976a">mobilesync_send_changes</a> (<a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> client, plist_t entities, uint8_t is_last_record, plist_t actions)</td></tr>
- <tr class="memdesc:a9d27a8141804c3527af0ea54c2d1976a"><td class="mdescLeft"> </td><td class="mdescRight">Sends changed entities of the currently set data class to the device. <a href="#a9d27a8141804c3527af0ea54c2d1976a">More...</a><br /></td></tr>
- <tr class="separator:a9d27a8141804c3527af0ea54c2d1976a"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:ac22e10874abce6b1dfa34a4a44e13607"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#ac22e10874abce6b1dfa34a4a44e13607">mobilesync_remap_identifiers</a> (<a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> client, plist_t *mapping)</td></tr>
- <tr class="memdesc:ac22e10874abce6b1dfa34a4a44e13607"><td class="mdescLeft"> </td><td class="mdescRight">Receives any remapped identifiers reported after the device merged submitted changes. <a href="#ac22e10874abce6b1dfa34a4a44e13607">More...</a><br /></td></tr>
- <tr class="separator:ac22e10874abce6b1dfa34a4a44e13607"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a8624bfd0265ecb8a79f042da3f9fdb85"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilesync_8h.html#a8c58f99e22c6fa4ad18073d31f71cb3b">mobilesync_anchors_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#a8624bfd0265ecb8a79f042da3f9fdb85">mobilesync_anchors_new</a> (const char *device_anchor, const char *computer_anchor)</td></tr>
- <tr class="memdesc:a8624bfd0265ecb8a79f042da3f9fdb85"><td class="mdescLeft"> </td><td class="mdescRight">Allocates memory for a new anchors struct initialized with the passed anchors. <a href="#a8624bfd0265ecb8a79f042da3f9fdb85">More...</a><br /></td></tr>
- <tr class="separator:a8624bfd0265ecb8a79f042da3f9fdb85"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a3430ddf7577dc5953b8d7f68b77bb05e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#a3430ddf7577dc5953b8d7f68b77bb05e">mobilesync_anchors_free</a> (<a class="el" href="mobilesync_8h.html#a8c58f99e22c6fa4ad18073d31f71cb3b">mobilesync_anchors_t</a> anchors)</td></tr>
- <tr class="memdesc:a3430ddf7577dc5953b8d7f68b77bb05e"><td class="mdescLeft"> </td><td class="mdescRight">Free memory used by anchors. <a href="#a3430ddf7577dc5953b8d7f68b77bb05e">More...</a><br /></td></tr>
- <tr class="separator:a3430ddf7577dc5953b8d7f68b77bb05e"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a4278a6db170aa5f8ee9b1bc8d41b5166"><td class="memItemLeft" align="right" valign="top">plist_t </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#a4278a6db170aa5f8ee9b1bc8d41b5166">mobilesync_actions_new</a> (void)</td></tr>
- <tr class="memdesc:a4278a6db170aa5f8ee9b1bc8d41b5166"><td class="mdescLeft"> </td><td class="mdescRight">Create a new actions plist to use in <a class="el" href="mobilesync_8h.html#a9d27a8141804c3527af0ea54c2d1976a" title="Sends changed entities of the currently set data class to the device. ">mobilesync_send_changes()</a>. <a href="#a4278a6db170aa5f8ee9b1bc8d41b5166">More...</a><br /></td></tr>
- <tr class="separator:a4278a6db170aa5f8ee9b1bc8d41b5166"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:a31fa461853c1a39b1a86c2517611093f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#a31fa461853c1a39b1a86c2517611093f">mobilesync_actions_add</a> (plist_t actions,...)</td></tr>
- <tr class="memdesc:a31fa461853c1a39b1a86c2517611093f"><td class="mdescLeft"> </td><td class="mdescRight">Add one or more new key:value pairs to the given actions plist. <a href="#a31fa461853c1a39b1a86c2517611093f">More...</a><br /></td></tr>
- <tr class="separator:a31fa461853c1a39b1a86c2517611093f"><td class="memSeparator" colspan="2"> </td></tr>
- <tr class="memitem:afa2edaa908a063346974208e674a3d3d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="mobilesync_8h.html#afa2edaa908a063346974208e674a3d3d">mobilesync_actions_free</a> (plist_t actions)</td></tr>
- <tr class="memdesc:afa2edaa908a063346974208e674a3d3d"><td class="mdescLeft"> </td><td class="mdescRight">Free actions plist. <a href="#afa2edaa908a063346974208e674a3d3d">More...</a><br /></td></tr>
- <tr class="separator:afa2edaa908a063346974208e674a3d3d"><td class="memSeparator" colspan="2"> </td></tr>
- </table>
- <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
- <div class="textblock"><p>Synchronize data classes with a device and computer. </p>
- </div><h2 class="groupheader">Typedef Documentation</h2>
- <a class="anchor" id="a8c58f99e22c6fa4ad18073d31f71cb3b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">typedef <a class="el" href="structmobilesync__anchors.html">mobilesync_anchors</a>* <a class="el" href="mobilesync_8h.html#a8c58f99e22c6fa4ad18073d31f71cb3b">mobilesync_anchors_t</a></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Anchors used by the device and computer. </p>
- </div>
- </div>
- <h2 class="groupheader">Enumeration Type Documentation</h2>
- <a class="anchor" id="ac9f9e31e087d8a816ddb4aeed1eea80c"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">enum <a class="el" href="mobilesync_8h.html#ac9f9e31e087d8a816ddb4aeed1eea80c">mobilesync_sync_type_t</a></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>The sync type of the current sync session. </p>
- <table class="fieldtable">
- <tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="ac9f9e31e087d8a816ddb4aeed1eea80cae0430179c44c50bef80b51f990eee230"></a>MOBILESYNC_SYNC_TYPE_FAST </td><td class="fielddoc">
- <p>Fast-sync requires that only the changes made since the last synchronization should be reported by the computer. </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="ac9f9e31e087d8a816ddb4aeed1eea80caeffffd3b2f288fad21820cd403780100"></a>MOBILESYNC_SYNC_TYPE_SLOW </td><td class="fielddoc">
- <p>Slow-sync requires that all data from the computer needs to be synchronized/sent. </p>
- </td></tr>
- <tr><td class="fieldname"><a class="anchor" id="ac9f9e31e087d8a816ddb4aeed1eea80ca8327459ac3c534d30050e76cd30f95c1"></a>MOBILESYNC_SYNC_TYPE_RESET </td><td class="fielddoc">
- <p>Reset-sync signals that the computer should send all data again. </p>
- </td></tr>
- </table>
- </div>
- </div>
- <h2 class="groupheader">Function Documentation</h2>
- <a class="anchor" id="a8e93751ac8f9cd584b16b946b7618abf"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> mobilesync_acknowledge_changes_from_device </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> </td>
- <td class="paramname"><em>client</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Acknowledges to the device that the changes have been merged on the computer. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The mobilesync client</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="retval"><dt>Return values</dt><dd>
- <table class="retval">
- <tr><td class="paramname">MOBILESYNC_E_SUCCESS</td><td>on success </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_INVALID_ARG</td><td>if one of the parameters is invalid </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a31fa461853c1a39b1a86c2517611093f"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void mobilesync_actions_add </td>
- <td>(</td>
- <td class="paramtype">plist_t </td>
- <td class="paramname"><em>actions</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"> </td>
- <td class="paramname"><em>...</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Add one or more new key:value pairs to the given actions plist. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">actions</td><td>The actions to modify. </td></tr>
- <tr><td class="paramname">...</td><td>KEY, VALUE, [KEY, VALUE], NULL</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section note"><dt>Note</dt><dd>The known keys so far are "SyncDeviceLinkEntityNamesKey" which expects an array of entity names, followed by a count paramter as well as "SyncDeviceLinkAllRecordsOfPulledEntityTypeSentKey" which expects an integer to use as a boolean value indicating that the device should link submitted changes and report remapped identifiers. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="afa2edaa908a063346974208e674a3d3d"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void mobilesync_actions_free </td>
- <td>(</td>
- <td class="paramtype">plist_t </td>
- <td class="paramname"><em>actions</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Free actions plist. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">actions</td><td>The actions plist to free. Does nothing if NULL is passed. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a4278a6db170aa5f8ee9b1bc8d41b5166"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">plist_t mobilesync_actions_new </td>
- <td>(</td>
- <td class="paramtype">void </td>
- <td class="paramname"></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Create a new actions plist to use in <a class="el" href="mobilesync_8h.html#a9d27a8141804c3527af0ea54c2d1976a" title="Sends changed entities of the currently set data class to the device. ">mobilesync_send_changes()</a>. </p>
- <dl class="section return"><dt>Returns</dt><dd>A new plist_t of type PLIST_DICT. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a3430ddf7577dc5953b8d7f68b77bb05e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">void mobilesync_anchors_free </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilesync_8h.html#a8c58f99e22c6fa4ad18073d31f71cb3b">mobilesync_anchors_t</a> </td>
- <td class="paramname"><em>anchors</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Free memory used by anchors. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">anchors</td><td>The anchors to free. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a8624bfd0265ecb8a79f042da3f9fdb85"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilesync_8h.html#a8c58f99e22c6fa4ad18073d31f71cb3b">mobilesync_anchors_t</a> mobilesync_anchors_new </td>
- <td>(</td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>device_anchor</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>computer_anchor</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Allocates memory for a new anchors struct initialized with the passed anchors. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">device_anchor</td><td>An anchor the device reported the last time or NULL if none is known yet which for instance is true on first synchronization. </td></tr>
- <tr><td class="paramname">computer_anchor</td><td>An arbitrary string to use as anchor for the computer.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>A new <a class="el" href="mobilesync_8h.html#a8c58f99e22c6fa4ad18073d31f71cb3b" title="Anchors used by the device and computer. ">mobilesync_anchors_t</a> struct. Must be freed using <a class="el" href="mobilesync_8h.html#a3430ddf7577dc5953b8d7f68b77bb05e" title="Free memory used by anchors. ">mobilesync_anchors_free()</a>. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="afdabe2be886c047027bf059e337339fd"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> mobilesync_cancel </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>reason</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Cancels a running synchronization session with a device at any time. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The mobilesync client </td></tr>
- <tr><td class="paramname">reason</td><td>The reason to supply to the device for cancelling</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="retval"><dt>Return values</dt><dd>
- <table class="retval">
- <tr><td class="paramname">MOBILESYNC_E_SUCCESS</td><td>on success </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_INVALID_ARG</td><td>if one of the parameters is invalid </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="adcb1b94b5dcbc58c2a4f34339f64f253"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> mobilesync_clear_all_records_on_device </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> </td>
- <td class="paramname"><em>client</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Requests the device to delete all records of the current data class. </p>
- <dl class="section note"><dt>Note</dt><dd>The operation must be called after starting synchronization.</dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The mobilesync client</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="retval"><dt>Return values</dt><dd>
- <table class="retval">
- <tr><td class="paramname">MOBILESYNC_E_SUCCESS</td><td>on success </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_INVALID_ARG</td><td>if one of the parameters is invalid </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_PLIST_ERROR</td><td>if the received plist is not of valid form </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a684e78bdb59be1169217f3e9d7fbc2da"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> mobilesync_client_free </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> </td>
- <td class="paramname"><em>client</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Disconnects a mobilesync client from the device and frees up the mobilesync client data. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The mobilesync client to disconnect and free.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="retval"><dt>Return values</dt><dd>
- <table class="retval">
- <tr><td class="paramname">MOBILESYNC_E_SUCCESS</td><td>on success </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_INVALID_ARG</td><td>if <em>client</em> is NULL. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a58d7d7755eefd092f029834392deddc8"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> mobilesync_client_new </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> </td>
- <td class="paramname"><em>device</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">lockdownd_service_descriptor_t </td>
- <td class="paramname"><em>service</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> * </td>
- <td class="paramname"><em>client</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Connects to the mobilesync service on the specified device. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
- <tr><td class="paramname">service</td><td>The service descriptor returned by lockdownd_start_service. </td></tr>
- <tr><td class="paramname">client</td><td>Pointer that will be set to a newly allocated <a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650" title="The client handle. ">mobilesync_client_t</a> upon successful return.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="retval"><dt>Return values</dt><dd>
- <table class="retval">
- <tr><td class="paramname">MOBILESYNC_E_SUCCESS</td><td>on success </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_INVALID_ARG</td><td>if one or more parameters are invalid </td></tr>
- <tr><td class="paramname">DEVICE_LINK_SERVICE_E_BAD_VERSION</td><td>if the mobilesync version on the device is newer. </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a42644361b6d783f04d00eed29f05d314"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> mobilesync_client_start_service </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> </td>
- <td class="paramname"><em>device</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> * </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>label</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Starts a new mobilesync service on the specified device and connects to it. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
- <tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated mobilesync_client_t upon successful return. Must be freed using <a class="el" href="mobilesync_8h.html#a684e78bdb59be1169217f3e9d7fbc2da" title="Disconnects a mobilesync client from the device and frees up the mobilesync client data...">mobilesync_client_free()</a> after use. </td></tr>
- <tr><td class="paramname">label</td><td>The label to use for communication. Usually the program name. Pass NULL to disable sending the label in requests to lockdownd.</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>MOBILESYNC_E_SUCCESS on success, or an MOBILESYNC_E_* error code otherwise. </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a2b6d0acc51dc8a1e9064c79c54cdbcea"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> mobilesync_finish </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> </td>
- <td class="paramname"><em>client</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Finish a synchronization session of a data class on the device. </p>
- <p>A session must have previously been started using <a class="el" href="mobilesync_8h.html#a02d0232ec6986ef27a9a02d6a877d865" title="Requests starting synchronization of a data class with the device. ">mobilesync_start()</a>.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The mobilesync client</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="retval"><dt>Return values</dt><dd>
- <table class="retval">
- <tr><td class="paramname">MOBILESYNC_E_SUCCESS</td><td>on success </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_INVALID_ARG</td><td>if one of the parameters is invalid </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_PLIST_ERROR</td><td>if the received plist is not of valid form </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="ab5c816504e565b9f391a7b1692667e7b"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> mobilesync_get_all_records_from_device </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> </td>
- <td class="paramname"><em>client</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Requests to receive all records of the currently set data class from the device. </p>
- <p>The actually changes are retrieved using <a class="el" href="mobilesync_8h.html#aad274556b5e793d0d4ebd83dbef8f20e" title="Receives changed entitites of the currently set data class from the device. ">mobilesync_receive_changes()</a> after this request has been successful.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The mobilesync client</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="retval"><dt>Return values</dt><dd>
- <table class="retval">
- <tr><td class="paramname">MOBILESYNC_E_SUCCESS</td><td>on success </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_INVALID_ARG</td><td>if one of the parameters is invalid </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a96b9227e7e8d6602329b4c10d99ce9bb"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> mobilesync_get_changes_from_device </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> </td>
- <td class="paramname"><em>client</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Requests to receive only changed records of the currently set data class from the device. </p>
- <p>The actually changes are retrieved using <a class="el" href="mobilesync_8h.html#aad274556b5e793d0d4ebd83dbef8f20e" title="Receives changed entitites of the currently set data class from the device. ">mobilesync_receive_changes()</a> after this request has been successful.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The mobilesync client</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="retval"><dt>Return values</dt><dd>
- <table class="retval">
- <tr><td class="paramname">MOBILESYNC_E_SUCCESS</td><td>on success </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_INVALID_ARG</td><td>if one of the parameters is invalid </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a19bca33f057c33d0487ac1947beaeceb"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> mobilesync_ready_to_send_changes_from_computer </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> </td>
- <td class="paramname"><em>client</em></td><td>)</td>
- <td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Verifies if the device is ready to receive changes from the computer. </p>
- <p>This call changes the synchronization direction so that <a class="el" href="mobilesync_8h.html#a9d27a8141804c3527af0ea54c2d1976a" title="Sends changed entities of the currently set data class to the device. ">mobilesync_send_changes()</a> can be used to send changes to the device.</p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The mobilesync client</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="retval"><dt>Return values</dt><dd>
- <table class="retval">
- <tr><td class="paramname">MOBILESYNC_E_SUCCESS</td><td>on success </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_INVALID_ARG</td><td>if one of the parameters is invalid </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_PLIST_ERROR</td><td>if the received plist is not of valid form </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_WRONG_DIRECTION</td><td>if the current sync direction does not permit this call </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_CANCELLED</td><td>if the device explicitly cancelled the session </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_NOT_READY</td><td>if the device is not ready to start receiving any changes </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a85d593631f8dddd7f58691c7351a1f44"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> mobilesync_receive </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">plist_t * </td>
- <td class="paramname"><em>plist</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Polls the device for mobilesync data. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The mobilesync client </td></tr>
- <tr><td class="paramname">plist</td><td>A pointer to the location where the plist should be stored</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>an error code </dd></dl>
- </div>
- </div>
- <a class="anchor" id="aad274556b5e793d0d4ebd83dbef8f20e"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> mobilesync_receive_changes </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">plist_t * </td>
- <td class="paramname"><em>entities</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint8_t * </td>
- <td class="paramname"><em>is_last_record</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">plist_t * </td>
- <td class="paramname"><em>actions</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Receives changed entitites of the currently set data class from the device. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The mobilesync client </td></tr>
- <tr><td class="paramname">entities</td><td>A pointer to store the changed entity records as a PLIST_DICT </td></tr>
- <tr><td class="paramname">is_last_record</td><td>A pointer to store a flag indicating if this submission is the last one </td></tr>
- <tr><td class="paramname">actions</td><td>A pointer to additional flags the device is sending or NULL to ignore</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="retval"><dt>Return values</dt><dd>
- <table class="retval">
- <tr><td class="paramname">MOBILESYNC_E_SUCCESS</td><td>on success </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_INVALID_ARG</td><td>if one of the parameters is invalid </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_CANCELLED</td><td>if the device explicitly cancelled the session </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="ac22e10874abce6b1dfa34a4a44e13607"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> mobilesync_remap_identifiers </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">plist_t * </td>
- <td class="paramname"><em>mapping</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Receives any remapped identifiers reported after the device merged submitted changes. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The mobilesync client </td></tr>
- <tr><td class="paramname">mapping</td><td>A pointer to an array plist containing a dict of identifier remappings</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="retval"><dt>Return values</dt><dd>
- <table class="retval">
- <tr><td class="paramname">MOBILESYNC_E_SUCCESS</td><td>on success </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_INVALID_ARG</td><td>if one of the parameters is invalid </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_PLIST_ERROR</td><td>if the received plist is not of valid form </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_WRONG_DIRECTION</td><td>if the current sync direction does not permit this call </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_CANCELLED</td><td>if the device explicitly cancelled the session </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a76e54260a77572f07327cbc17d805533"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> mobilesync_send </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">plist_t </td>
- <td class="paramname"><em>plist</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sends mobilesync data to the device. </p>
- <dl class="section note"><dt>Note</dt><dd>This function is low-level and should only be used if you need to send a new type of message.</dd></dl>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The mobilesync client </td></tr>
- <tr><td class="paramname">plist</td><td>The location of the plist to send</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="section return"><dt>Returns</dt><dd>an error code </dd></dl>
- </div>
- </div>
- <a class="anchor" id="a9d27a8141804c3527af0ea54c2d1976a"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> mobilesync_send_changes </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">plist_t </td>
- <td class="paramname"><em>entities</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint8_t </td>
- <td class="paramname"><em>is_last_record</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">plist_t </td>
- <td class="paramname"><em>actions</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Sends changed entities of the currently set data class to the device. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The mobilesync client </td></tr>
- <tr><td class="paramname">entities</td><td>The changed entity records as a PLIST_DICT </td></tr>
- <tr><td class="paramname">is_last_record</td><td>A flag indicating if this submission is the last one </td></tr>
- <tr><td class="paramname">actions</td><td>Additional actions for the device created with <a class="el" href="mobilesync_8h.html#a4278a6db170aa5f8ee9b1bc8d41b5166" title="Create a new actions plist to use in mobilesync_send_changes(). ">mobilesync_actions_new()</a> or NULL if no actions should be passed</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="retval"><dt>Return values</dt><dd>
- <table class="retval">
- <tr><td class="paramname">MOBILESYNC_E_SUCCESS</td><td>on success </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_INVALID_ARG</td><td>if one of the parameters is invalid, </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_WRONG_DIRECTION</td><td>if the current sync direction does not permit this call </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- <a class="anchor" id="a02d0232ec6986ef27a9a02d6a877d865"></a>
- <div class="memitem">
- <div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="mobilesync_8h.html#a11a123e7523156d4fc7d455f0a345eeb">mobilesync_error_t</a> mobilesync_start </td>
- <td>(</td>
- <td class="paramtype"><a class="el" href="mobilesync_8h.html#ae9416410eb63a6f40c144f5e13576650">mobilesync_client_t</a> </td>
- <td class="paramname"><em>client</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">const char * </td>
- <td class="paramname"><em>data_class</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="mobilesync_8h.html#a8c58f99e22c6fa4ad18073d31f71cb3b">mobilesync_anchors_t</a> </td>
- <td class="paramname"><em>anchors</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint64_t </td>
- <td class="paramname"><em>computer_data_class_version</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype"><a class="el" href="mobilesync_8h.html#ac9f9e31e087d8a816ddb4aeed1eea80c">mobilesync_sync_type_t</a> * </td>
- <td class="paramname"><em>sync_type</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">uint64_t * </td>
- <td class="paramname"><em>device_data_class_version</em>, </td>
- </tr>
- <tr>
- <td class="paramkey"></td>
- <td></td>
- <td class="paramtype">char ** </td>
- <td class="paramname"><em>error_description</em> </td>
- </tr>
- <tr>
- <td></td>
- <td>)</td>
- <td></td><td></td>
- </tr>
- </table>
- </div><div class="memdoc">
- <p>Requests starting synchronization of a data class with the device. </p>
- <dl class="params"><dt>Parameters</dt><dd>
- <table class="params">
- <tr><td class="paramname">client</td><td>The mobilesync client </td></tr>
- <tr><td class="paramname">data_class</td><td>The data class identifier to sync </td></tr>
- <tr><td class="paramname">anchors</td><td>The anchors required to exchange with the device. The anchors allow the device to tell if the synchronization information on the computer and device are consistent to determine what sync type is required. </td></tr>
- <tr><td class="paramname">computer_data_class_version</td><td>The version of the data class storage on the computer </td></tr>
- <tr><td class="paramname">sync_type</td><td>A pointer to store the sync type reported by the device_anchor </td></tr>
- <tr><td class="paramname">device_data_class_version</td><td>The version of the data class storage on the device </td></tr>
- <tr><td class="paramname">error_description</td><td>A pointer to store an error message if reported by the device</td></tr>
- </table>
- </dd>
- </dl>
- <dl class="retval"><dt>Return values</dt><dd>
- <table class="retval">
- <tr><td class="paramname">MOBILESYNC_E_SUCCESS</td><td>on success </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_INVALID_ARG</td><td>if one of the parameters is invalid </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_PLIST_ERROR</td><td>if the received plist is not of valid form </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_SYNC_REFUSED</td><td>if the device refused to sync </td></tr>
- <tr><td class="paramname">MOBILESYNC_E_CANCELLED</td><td>if the device explicitly cancelled the sync request </td></tr>
- </table>
- </dd>
- </dl>
- </div>
- </div>
- </div><!-- contents -->
- <!-- start footer part -->
- <hr class="footer"/><address class="footer"><small>
- Generated on Wed Jan 28 2015 23:15:48 for libimobiledevice by  <a href="http://www.doxygen.org/index.html">
- <img class="footer" src="doxygen.png" alt="doxygen"/>
- </a> 1.8.8
- </small></address>
- </body>
- </html>
|