mobilebackup_8h.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.8"/>
  7. <title>libimobiledevice: libimobiledevice/mobilebackup.h File Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. </head>
  13. <body>
  14. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  15. <div id="titlearea">
  16. <table cellspacing="0" cellpadding="0">
  17. <tbody>
  18. <tr style="height: 56px;">
  19. <td style="padding-left: 0.5em;">
  20. <div id="projectname">libimobiledevice
  21. &#160;<span id="projectnumber">1.2.0</span>
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.8 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  34. <li class="current"><a href="files.html"><span>Files</span></a></li>
  35. </ul>
  36. </div>
  37. <div id="navrow2" class="tabs2">
  38. <ul class="tablist">
  39. <li><a href="files.html"><span>File&#160;List</span></a></li>
  40. <li><a href="globals.html"><span>Globals</span></a></li>
  41. </ul>
  42. </div>
  43. <div id="nav-path" class="navpath">
  44. <ul>
  45. <li class="navelem"><a class="el" href="dir_6f94c0669708509ba6e66291c679659c.html">libimobiledevice</a></li> </ul>
  46. </div>
  47. </div><!-- top -->
  48. <div class="header">
  49. <div class="summary">
  50. <a href="#define-members">Macros</a> &#124;
  51. <a href="#typedef-members">Typedefs</a> &#124;
  52. <a href="#enum-members">Enumerations</a> &#124;
  53. <a href="#func-members">Functions</a> </div>
  54. <div class="headertitle">
  55. <div class="title">mobilebackup.h File Reference</div> </div>
  56. </div><!--header-->
  57. <div class="contents">
  58. <p>Backup and restore of all device data.
  59. <a href="#details">More...</a></p>
  60. <table class="memberdecls">
  61. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
  62. Macros</h2></td></tr>
  63. <tr class="memitem:ad4179f0791327356e6aeb1a8aedf7794"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad4179f0791327356e6aeb1a8aedf7794"></a>
  64. #define&#160;</td><td class="memItemRight" valign="bottom"><b>MOBILEBACKUP_SERVICE_NAME</b>&#160;&#160;&#160;&quot;com.apple.mobilebackup&quot;</td></tr>
  65. <tr class="separator:ad4179f0791327356e6aeb1a8aedf7794"><td class="memSeparator" colspan="2">&#160;</td></tr>
  66. </table><table class="memberdecls">
  67. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
  68. Typedefs</h2></td></tr>
  69. <tr class="memitem:aa3178d164fe65038c4314ac45a2a6953"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa3178d164fe65038c4314ac45a2a6953"></a>
  70. typedef struct <br class="typebreak" />
  71. mobilebackup_client_private&#160;</td><td class="memItemRight" valign="bottom"><b>mobilebackup_client_private</b></td></tr>
  72. <tr class="separator:aa3178d164fe65038c4314ac45a2a6953"><td class="memSeparator" colspan="2">&#160;</td></tr>
  73. <tr class="memitem:a80c8c3310e73ac1ac6cdb565635a9af8"><td class="memItemLeft" align="right" valign="top">typedef <br class="typebreak" />
  74. mobilebackup_client_private *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a></td></tr>
  75. <tr class="memdesc:a80c8c3310e73ac1ac6cdb565635a9af8"><td class="mdescLeft">&#160;</td><td class="mdescRight">The client handle. <a href="#a80c8c3310e73ac1ac6cdb565635a9af8">More...</a><br /></td></tr>
  76. <tr class="separator:a80c8c3310e73ac1ac6cdb565635a9af8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  77. </table><table class="memberdecls">
  78. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  79. Enumerations</h2></td></tr>
  80. <tr class="memitem:a871f2dcf590edff5b17156a464784e9f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a871f2dcf590edff5b17156a464784e9f"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> { <br />
  81. &#160;&#160;<b>MOBILEBACKUP_E_SUCCESS</b> = 0,
  82. <br />
  83. &#160;&#160;<b>MOBILEBACKUP_E_INVALID_ARG</b> = -1,
  84. <br />
  85. &#160;&#160;<b>MOBILEBACKUP_E_PLIST_ERROR</b> = -2,
  86. <br />
  87. &#160;&#160;<b>MOBILEBACKUP_E_MUX_ERROR</b> = -3,
  88. <br />
  89. &#160;&#160;<b>MOBILEBACKUP_E_BAD_VERSION</b> = -4,
  90. <br />
  91. &#160;&#160;<b>MOBILEBACKUP_E_REPLY_NOT_OK</b> = -5,
  92. <br />
  93. &#160;&#160;<b>MOBILEBACKUP_E_UNKNOWN_ERROR</b> = -256
  94. <br />
  95. }</td></tr>
  96. <tr class="memdesc:a871f2dcf590edff5b17156a464784e9f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error Codes. <br /></td></tr>
  97. <tr class="separator:a871f2dcf590edff5b17156a464784e9f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  98. <tr class="memitem:a901e0f8f2cd63280b9a9d68bd7e8c23d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a901e0f8f2cd63280b9a9d68bd7e8c23d"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><b>mobilebackup_flags_t</b> { <br />
  99. &#160;&#160;<b>MB_RESTORE_NOTIFY_SPRINGBOARD</b> = 1 &lt;&lt; 0,
  100. <br />
  101. &#160;&#160;<b>MB_RESTORE_PRESERVE_SETTINGS</b> = 1 &lt;&lt; 1,
  102. <br />
  103. &#160;&#160;<b>MB_RESTORE_PRESERVE_CAMERA_ROLL</b> = 1 &lt;&lt; 2
  104. <br />
  105. }</td></tr>
  106. <tr class="separator:a901e0f8f2cd63280b9a9d68bd7e8c23d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. </table><table class="memberdecls">
  108. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  109. Functions</h2></td></tr>
  110. <tr class="memitem:a7f7b7933f7a312a28e701e9bd1825f02"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#a7f7b7933f7a312a28e701e9bd1825f02">mobilebackup_client_new</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, lockdownd_service_descriptor_t service, <a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> *client)</td></tr>
  111. <tr class="memdesc:a7f7b7933f7a312a28e701e9bd1825f02"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connects to the mobilebackup service on the specified device. <a href="#a7f7b7933f7a312a28e701e9bd1825f02">More...</a><br /></td></tr>
  112. <tr class="separator:a7f7b7933f7a312a28e701e9bd1825f02"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:ad448008226608f4636b713b8cbd20c04"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#ad448008226608f4636b713b8cbd20c04">mobilebackup_client_start_service</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, <a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> *client, const char *label)</td></tr>
  114. <tr class="memdesc:ad448008226608f4636b713b8cbd20c04"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts a new mobilebackup service on the specified device and connects to it. <a href="#ad448008226608f4636b713b8cbd20c04">More...</a><br /></td></tr>
  115. <tr class="separator:ad448008226608f4636b713b8cbd20c04"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:aceff0d79d743e3b9e2974ef1ff298c6f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#aceff0d79d743e3b9e2974ef1ff298c6f">mobilebackup_client_free</a> (<a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> client)</td></tr>
  117. <tr class="memdesc:aceff0d79d743e3b9e2974ef1ff298c6f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects a mobilebackup client from the device and frees up the mobilebackup client data. <a href="#aceff0d79d743e3b9e2974ef1ff298c6f">More...</a><br /></td></tr>
  118. <tr class="separator:aceff0d79d743e3b9e2974ef1ff298c6f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. <tr class="memitem:ab141879e1be237c2b3e3b739fe31b6b5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#ab141879e1be237c2b3e3b739fe31b6b5">mobilebackup_receive</a> (<a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> client, plist_t *plist)</td></tr>
  120. <tr class="memdesc:ab141879e1be237c2b3e3b739fe31b6b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Polls the device for mobilebackup data. <a href="#ab141879e1be237c2b3e3b739fe31b6b5">More...</a><br /></td></tr>
  121. <tr class="separator:ab141879e1be237c2b3e3b739fe31b6b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  122. <tr class="memitem:a868886fd24134178fea043e5cbaa3a75"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#a868886fd24134178fea043e5cbaa3a75">mobilebackup_send</a> (<a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> client, plist_t plist)</td></tr>
  123. <tr class="memdesc:a868886fd24134178fea043e5cbaa3a75"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends mobilebackup data to the device. <a href="#a868886fd24134178fea043e5cbaa3a75">More...</a><br /></td></tr>
  124. <tr class="separator:a868886fd24134178fea043e5cbaa3a75"><td class="memSeparator" colspan="2">&#160;</td></tr>
  125. <tr class="memitem:a22a4ffba65451178d42251643edf7cb8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#a22a4ffba65451178d42251643edf7cb8">mobilebackup_request_backup</a> (<a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> client, plist_t backup_manifest, const char *base_path, const char *proto_version)</td></tr>
  126. <tr class="memdesc:a22a4ffba65451178d42251643edf7cb8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request a backup from the connected device. <a href="#a22a4ffba65451178d42251643edf7cb8">More...</a><br /></td></tr>
  127. <tr class="separator:a22a4ffba65451178d42251643edf7cb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  128. <tr class="memitem:a684dd7ebb0111f8a8ca7ab4119199be9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#a684dd7ebb0111f8a8ca7ab4119199be9">mobilebackup_send_backup_file_received</a> (<a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> client)</td></tr>
  129. <tr class="memdesc:a684dd7ebb0111f8a8ca7ab4119199be9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends a confirmation to the device that a backup file has been received. <a href="#a684dd7ebb0111f8a8ca7ab4119199be9">More...</a><br /></td></tr>
  130. <tr class="separator:a684dd7ebb0111f8a8ca7ab4119199be9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  131. <tr class="memitem:ac09e0685762314ea1c1f8ffcfc623975"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#ac09e0685762314ea1c1f8ffcfc623975">mobilebackup_request_restore</a> (<a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> client, plist_t backup_manifest, mobilebackup_flags_t flags, const char *proto_version)</td></tr>
  132. <tr class="memdesc:ac09e0685762314ea1c1f8ffcfc623975"><td class="mdescLeft">&#160;</td><td class="mdescRight">Request that a backup should be restored to the connected device. <a href="#ac09e0685762314ea1c1f8ffcfc623975">More...</a><br /></td></tr>
  133. <tr class="separator:ac09e0685762314ea1c1f8ffcfc623975"><td class="memSeparator" colspan="2">&#160;</td></tr>
  134. <tr class="memitem:a97467648d4c5d77bc7f1fbe23722a61e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#a97467648d4c5d77bc7f1fbe23722a61e">mobilebackup_receive_restore_file_received</a> (<a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> client, plist_t *result)</td></tr>
  135. <tr class="memdesc:a97467648d4c5d77bc7f1fbe23722a61e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive a confirmation from the device that it successfully received a restore file. <a href="#a97467648d4c5d77bc7f1fbe23722a61e">More...</a><br /></td></tr>
  136. <tr class="separator:a97467648d4c5d77bc7f1fbe23722a61e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  137. <tr class="memitem:a7cef0478b30d26fbd0a5f146815e202e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#a7cef0478b30d26fbd0a5f146815e202e">mobilebackup_receive_restore_application_received</a> (<a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> client, plist_t *result)</td></tr>
  138. <tr class="memdesc:a7cef0478b30d26fbd0a5f146815e202e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Receive a confirmation from the device that it successfully received application data file. <a href="#a7cef0478b30d26fbd0a5f146815e202e">More...</a><br /></td></tr>
  139. <tr class="separator:a7cef0478b30d26fbd0a5f146815e202e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:adb1ef11295238147532e84878b924a5e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#adb1ef11295238147532e84878b924a5e">mobilebackup_send_restore_complete</a> (<a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> client)</td></tr>
  141. <tr class="memdesc:adb1ef11295238147532e84878b924a5e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tells the device that the restore process is complete and waits for the device to close the connection. <a href="#adb1ef11295238147532e84878b924a5e">More...</a><br /></td></tr>
  142. <tr class="separator:adb1ef11295238147532e84878b924a5e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  143. <tr class="memitem:a68249f2d882e0264bdd45ea2abf1e6d1"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="mobilebackup_8h.html#a68249f2d882e0264bdd45ea2abf1e6d1">mobilebackup_send_error</a> (<a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> client, const char *reason)</td></tr>
  144. <tr class="memdesc:a68249f2d882e0264bdd45ea2abf1e6d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends a backup error message to the device. <a href="#a68249f2d882e0264bdd45ea2abf1e6d1">More...</a><br /></td></tr>
  145. <tr class="separator:a68249f2d882e0264bdd45ea2abf1e6d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  146. </table>
  147. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  148. <div class="textblock"><p>Backup and restore of all device data. </p>
  149. </div><h2 class="groupheader">Typedef Documentation</h2>
  150. <a class="anchor" id="a80c8c3310e73ac1ac6cdb565635a9af8"></a>
  151. <div class="memitem">
  152. <div class="memproto">
  153. <table class="memname">
  154. <tr>
  155. <td class="memname">typedef mobilebackup_client_private* <a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a></td>
  156. </tr>
  157. </table>
  158. </div><div class="memdoc">
  159. <p>The client handle. </p>
  160. </div>
  161. </div>
  162. <h2 class="groupheader">Function Documentation</h2>
  163. <a class="anchor" id="aceff0d79d743e3b9e2974ef1ff298c6f"></a>
  164. <div class="memitem">
  165. <div class="memproto">
  166. <table class="memname">
  167. <tr>
  168. <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_client_free </td>
  169. <td>(</td>
  170. <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a>&#160;</td>
  171. <td class="paramname"><em>client</em></td><td>)</td>
  172. <td></td>
  173. </tr>
  174. </table>
  175. </div><div class="memdoc">
  176. <p>Disconnects a mobilebackup client from the device and frees up the mobilebackup client data. </p>
  177. <dl class="params"><dt>Parameters</dt><dd>
  178. <table class="params">
  179. <tr><td class="paramname">client</td><td>The mobilebackup client to disconnect and free.</td></tr>
  180. </table>
  181. </dd>
  182. </dl>
  183. <dl class="section return"><dt>Returns</dt><dd>MOBILEBACKUP_E_SUCCESS on success, or MOBILEBACKUP_E_INVALID_ARG if client is NULL. </dd></dl>
  184. </div>
  185. </div>
  186. <a class="anchor" id="a7f7b7933f7a312a28e701e9bd1825f02"></a>
  187. <div class="memitem">
  188. <div class="memproto">
  189. <table class="memname">
  190. <tr>
  191. <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_client_new </td>
  192. <td>(</td>
  193. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
  194. <td class="paramname"><em>device</em>, </td>
  195. </tr>
  196. <tr>
  197. <td class="paramkey"></td>
  198. <td></td>
  199. <td class="paramtype">lockdownd_service_descriptor_t&#160;</td>
  200. <td class="paramname"><em>service</em>, </td>
  201. </tr>
  202. <tr>
  203. <td class="paramkey"></td>
  204. <td></td>
  205. <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> *&#160;</td>
  206. <td class="paramname"><em>client</em>&#160;</td>
  207. </tr>
  208. <tr>
  209. <td></td>
  210. <td>)</td>
  211. <td></td><td></td>
  212. </tr>
  213. </table>
  214. </div><div class="memdoc">
  215. <p>Connects to the mobilebackup service on the specified device. </p>
  216. <dl class="params"><dt>Parameters</dt><dd>
  217. <table class="params">
  218. <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
  219. <tr><td class="paramname">service</td><td>The service descriptor returned by lockdownd_start_service. </td></tr>
  220. <tr><td class="paramname">client</td><td>Pointer that will be set to a newly allocated mobilebackup_client_t upon successful return.</td></tr>
  221. </table>
  222. </dd>
  223. </dl>
  224. <dl class="section return"><dt>Returns</dt><dd>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. </dd></dl>
  225. </div>
  226. </div>
  227. <a class="anchor" id="ad448008226608f4636b713b8cbd20c04"></a>
  228. <div class="memitem">
  229. <div class="memproto">
  230. <table class="memname">
  231. <tr>
  232. <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_client_start_service </td>
  233. <td>(</td>
  234. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
  235. <td class="paramname"><em>device</em>, </td>
  236. </tr>
  237. <tr>
  238. <td class="paramkey"></td>
  239. <td></td>
  240. <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a> *&#160;</td>
  241. <td class="paramname"><em>client</em>, </td>
  242. </tr>
  243. <tr>
  244. <td class="paramkey"></td>
  245. <td></td>
  246. <td class="paramtype">const char *&#160;</td>
  247. <td class="paramname"><em>label</em>&#160;</td>
  248. </tr>
  249. <tr>
  250. <td></td>
  251. <td>)</td>
  252. <td></td><td></td>
  253. </tr>
  254. </table>
  255. </div><div class="memdoc">
  256. <p>Starts a new mobilebackup service on the specified device and connects to it. </p>
  257. <dl class="params"><dt>Parameters</dt><dd>
  258. <table class="params">
  259. <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
  260. <tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated mobilebackup_client_t upon successful return. Must be freed using <a class="el" href="mobilebackup_8h.html#aceff0d79d743e3b9e2974ef1ff298c6f" title="Disconnects a mobilebackup client from the device and frees up the mobilebackup client data...">mobilebackup_client_free()</a> after use. </td></tr>
  261. <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>
  262. </table>
  263. </dd>
  264. </dl>
  265. <dl class="section return"><dt>Returns</dt><dd>MOBILEBACKUP_E_SUCCESS on success, or an MOBILEBACKUP_E_* error code otherwise. </dd></dl>
  266. </div>
  267. </div>
  268. <a class="anchor" id="ab141879e1be237c2b3e3b739fe31b6b5"></a>
  269. <div class="memitem">
  270. <div class="memproto">
  271. <table class="memname">
  272. <tr>
  273. <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_receive </td>
  274. <td>(</td>
  275. <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a>&#160;</td>
  276. <td class="paramname"><em>client</em>, </td>
  277. </tr>
  278. <tr>
  279. <td class="paramkey"></td>
  280. <td></td>
  281. <td class="paramtype">plist_t *&#160;</td>
  282. <td class="paramname"><em>plist</em>&#160;</td>
  283. </tr>
  284. <tr>
  285. <td></td>
  286. <td>)</td>
  287. <td></td><td></td>
  288. </tr>
  289. </table>
  290. </div><div class="memdoc">
  291. <p>Polls the device for mobilebackup data. </p>
  292. <dl class="params"><dt>Parameters</dt><dd>
  293. <table class="params">
  294. <tr><td class="paramname">client</td><td>The mobilebackup client </td></tr>
  295. <tr><td class="paramname">plist</td><td>A pointer to the location where the plist should be stored</td></tr>
  296. </table>
  297. </dd>
  298. </dl>
  299. <dl class="section return"><dt>Returns</dt><dd>an error code </dd></dl>
  300. </div>
  301. </div>
  302. <a class="anchor" id="a7cef0478b30d26fbd0a5f146815e202e"></a>
  303. <div class="memitem">
  304. <div class="memproto">
  305. <table class="memname">
  306. <tr>
  307. <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_receive_restore_application_received </td>
  308. <td>(</td>
  309. <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a>&#160;</td>
  310. <td class="paramname"><em>client</em>, </td>
  311. </tr>
  312. <tr>
  313. <td class="paramkey"></td>
  314. <td></td>
  315. <td class="paramtype">plist_t *&#160;</td>
  316. <td class="paramname"><em>result</em>&#160;</td>
  317. </tr>
  318. <tr>
  319. <td></td>
  320. <td>)</td>
  321. <td></td><td></td>
  322. </tr>
  323. </table>
  324. </div><div class="memdoc">
  325. <p>Receive a confirmation from the device that it successfully received application data file. </p>
  326. <dl class="params"><dt>Parameters</dt><dd>
  327. <table class="params">
  328. <tr><td class="paramname">client</td><td>The connected MobileBackup client to use. </td></tr>
  329. <tr><td class="paramname">result</td><td>Pointer to a plist_t that will be set to the received plist for further processing. The caller has to free it using plist_free(). Note that it will be set to NULL if the operation itself fails due to a communication or plist error. If this parameter is NULL, it will be ignored.</td></tr>
  330. </table>
  331. </dd>
  332. </dl>
  333. <dl class="section return"><dt>Returns</dt><dd>MOBILEBACKUP_E_SUCCESS on success, MOBILEBACKUP_E_INVALID_ARG if client is invalid, MOBILEBACKUP_E_REPLY_NOT_OK if the expected 'BackupMessageRestoreApplicationReceived' message could not be received, MOBILEBACKUP_E_PLIST_ERROR if the received message is not a valid backup message plist, or MOBILEBACKUP_E_MUX_ERROR if a communication error occurs. </dd></dl>
  334. </div>
  335. </div>
  336. <a class="anchor" id="a97467648d4c5d77bc7f1fbe23722a61e"></a>
  337. <div class="memitem">
  338. <div class="memproto">
  339. <table class="memname">
  340. <tr>
  341. <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_receive_restore_file_received </td>
  342. <td>(</td>
  343. <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a>&#160;</td>
  344. <td class="paramname"><em>client</em>, </td>
  345. </tr>
  346. <tr>
  347. <td class="paramkey"></td>
  348. <td></td>
  349. <td class="paramtype">plist_t *&#160;</td>
  350. <td class="paramname"><em>result</em>&#160;</td>
  351. </tr>
  352. <tr>
  353. <td></td>
  354. <td>)</td>
  355. <td></td><td></td>
  356. </tr>
  357. </table>
  358. </div><div class="memdoc">
  359. <p>Receive a confirmation from the device that it successfully received a restore file. </p>
  360. <dl class="params"><dt>Parameters</dt><dd>
  361. <table class="params">
  362. <tr><td class="paramname">client</td><td>The connected MobileBackup client to use. </td></tr>
  363. <tr><td class="paramname">result</td><td>Pointer to a plist_t that will be set to the received plist for further processing. The caller has to free it using plist_free(). Note that it will be set to NULL if the operation itself fails due to a communication or plist error. If this parameter is NULL, it will be ignored.</td></tr>
  364. </table>
  365. </dd>
  366. </dl>
  367. <dl class="section return"><dt>Returns</dt><dd>MOBILEBACKUP_E_SUCCESS on success, MOBILEBACKUP_E_INVALID_ARG if client is invalid, MOBILEBACKUP_E_REPLY_NOT_OK if the expected 'BackupMessageRestoreFileReceived' message could not be received, MOBILEBACKUP_E_PLIST_ERROR if the received message is not a valid backup message plist, or MOBILEBACKUP_E_MUX_ERROR if a communication error occurs. </dd></dl>
  368. </div>
  369. </div>
  370. <a class="anchor" id="a22a4ffba65451178d42251643edf7cb8"></a>
  371. <div class="memitem">
  372. <div class="memproto">
  373. <table class="memname">
  374. <tr>
  375. <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_request_backup </td>
  376. <td>(</td>
  377. <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a>&#160;</td>
  378. <td class="paramname"><em>client</em>, </td>
  379. </tr>
  380. <tr>
  381. <td class="paramkey"></td>
  382. <td></td>
  383. <td class="paramtype">plist_t&#160;</td>
  384. <td class="paramname"><em>backup_manifest</em>, </td>
  385. </tr>
  386. <tr>
  387. <td class="paramkey"></td>
  388. <td></td>
  389. <td class="paramtype">const char *&#160;</td>
  390. <td class="paramname"><em>base_path</em>, </td>
  391. </tr>
  392. <tr>
  393. <td class="paramkey"></td>
  394. <td></td>
  395. <td class="paramtype">const char *&#160;</td>
  396. <td class="paramname"><em>proto_version</em>&#160;</td>
  397. </tr>
  398. <tr>
  399. <td></td>
  400. <td>)</td>
  401. <td></td><td></td>
  402. </tr>
  403. </table>
  404. </div><div class="memdoc">
  405. <p>Request a backup from the connected device. </p>
  406. <dl class="params"><dt>Parameters</dt><dd>
  407. <table class="params">
  408. <tr><td class="paramname">client</td><td>The connected MobileBackup client to use. </td></tr>
  409. <tr><td class="paramname">backup_manifest</td><td>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. </td></tr>
  410. <tr><td class="paramname">base_path</td><td>The base path on the device to use for the backup operation, usually "/". </td></tr>
  411. <tr><td class="paramname">proto_version</td><td>A string denoting the version of the backup protocol to use. Latest known version is "1.6"</td></tr>
  412. </table>
  413. </dd>
  414. </dl>
  415. <dl class="section return"><dt>Returns</dt><dd>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 </dd></dl>
  416. </div>
  417. </div>
  418. <a class="anchor" id="ac09e0685762314ea1c1f8ffcfc623975"></a>
  419. <div class="memitem">
  420. <div class="memproto">
  421. <table class="memname">
  422. <tr>
  423. <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_request_restore </td>
  424. <td>(</td>
  425. <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a>&#160;</td>
  426. <td class="paramname"><em>client</em>, </td>
  427. </tr>
  428. <tr>
  429. <td class="paramkey"></td>
  430. <td></td>
  431. <td class="paramtype">plist_t&#160;</td>
  432. <td class="paramname"><em>backup_manifest</em>, </td>
  433. </tr>
  434. <tr>
  435. <td class="paramkey"></td>
  436. <td></td>
  437. <td class="paramtype">mobilebackup_flags_t&#160;</td>
  438. <td class="paramname"><em>flags</em>, </td>
  439. </tr>
  440. <tr>
  441. <td class="paramkey"></td>
  442. <td></td>
  443. <td class="paramtype">const char *&#160;</td>
  444. <td class="paramname"><em>proto_version</em>&#160;</td>
  445. </tr>
  446. <tr>
  447. <td></td>
  448. <td>)</td>
  449. <td></td><td></td>
  450. </tr>
  451. </table>
  452. </div><div class="memdoc">
  453. <p>Request that a backup should be restored to the connected device. </p>
  454. <dl class="params"><dt>Parameters</dt><dd>
  455. <table class="params">
  456. <tr><td class="paramname">client</td><td>The connected MobileBackup client to use. </td></tr>
  457. <tr><td class="paramname">backup_manifest</td><td>The backup manifest, a plist_t of type PLIST_DICT containing the backup state to be restored. </td></tr>
  458. <tr><td class="paramname">flags</td><td>Flags to send with the request. Currently this is a combination of the following mobilebackup_flags_t: MB_RESTORE_NOTIFY_SPRINGBOARD - let SpringBoard show a 'Restore' screen MB_RESTORE_PRESERVE_SETTINGS - do not overwrite any settings MB_RESTORE_PRESERVE_CAMERA_ROLL - preserve the photos of the camera roll </td></tr>
  459. <tr><td class="paramname">proto_version</td><td>A string denoting the version of the backup protocol to use. Latest known version is "1.6". Ideally this value should be extracted from the given manifest plist.</td></tr>
  460. </table>
  461. </dd>
  462. </dl>
  463. <dl class="section return"><dt>Returns</dt><dd>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, or MOBILEBACKUP_E_REPLY_NOT_OK if the device did not accept the request. </dd></dl>
  464. </div>
  465. </div>
  466. <a class="anchor" id="a868886fd24134178fea043e5cbaa3a75"></a>
  467. <div class="memitem">
  468. <div class="memproto">
  469. <table class="memname">
  470. <tr>
  471. <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_send </td>
  472. <td>(</td>
  473. <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a>&#160;</td>
  474. <td class="paramname"><em>client</em>, </td>
  475. </tr>
  476. <tr>
  477. <td class="paramkey"></td>
  478. <td></td>
  479. <td class="paramtype">plist_t&#160;</td>
  480. <td class="paramname"><em>plist</em>&#160;</td>
  481. </tr>
  482. <tr>
  483. <td></td>
  484. <td>)</td>
  485. <td></td><td></td>
  486. </tr>
  487. </table>
  488. </div><div class="memdoc">
  489. <p>Sends mobilebackup data to the device. </p>
  490. <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>
  491. <dl class="params"><dt>Parameters</dt><dd>
  492. <table class="params">
  493. <tr><td class="paramname">client</td><td>The mobilebackup client </td></tr>
  494. <tr><td class="paramname">plist</td><td>The location of the plist to send</td></tr>
  495. </table>
  496. </dd>
  497. </dl>
  498. <dl class="section return"><dt>Returns</dt><dd>an error code </dd></dl>
  499. </div>
  500. </div>
  501. <a class="anchor" id="a684dd7ebb0111f8a8ca7ab4119199be9"></a>
  502. <div class="memitem">
  503. <div class="memproto">
  504. <table class="memname">
  505. <tr>
  506. <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_send_backup_file_received </td>
  507. <td>(</td>
  508. <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a>&#160;</td>
  509. <td class="paramname"><em>client</em></td><td>)</td>
  510. <td></td>
  511. </tr>
  512. </table>
  513. </div><div class="memdoc">
  514. <p>Sends a confirmation to the device that a backup file has been received. </p>
  515. <dl class="params"><dt>Parameters</dt><dd>
  516. <table class="params">
  517. <tr><td class="paramname">client</td><td>The connected MobileBackup client to use.</td></tr>
  518. </table>
  519. </dd>
  520. </dl>
  521. <dl class="section return"><dt>Returns</dt><dd>MOBILEBACKUP_E_SUCCESS on success, MOBILEBACKUP_E_INVALID_ARG if client is invalid, or MOBILEBACKUP_E_MUX_ERROR if a communication error occurs. </dd></dl>
  522. </div>
  523. </div>
  524. <a class="anchor" id="a68249f2d882e0264bdd45ea2abf1e6d1"></a>
  525. <div class="memitem">
  526. <div class="memproto">
  527. <table class="memname">
  528. <tr>
  529. <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_send_error </td>
  530. <td>(</td>
  531. <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a>&#160;</td>
  532. <td class="paramname"><em>client</em>, </td>
  533. </tr>
  534. <tr>
  535. <td class="paramkey"></td>
  536. <td></td>
  537. <td class="paramtype">const char *&#160;</td>
  538. <td class="paramname"><em>reason</em>&#160;</td>
  539. </tr>
  540. <tr>
  541. <td></td>
  542. <td>)</td>
  543. <td></td><td></td>
  544. </tr>
  545. </table>
  546. </div><div class="memdoc">
  547. <p>Sends a backup error message to the device. </p>
  548. <dl class="params"><dt>Parameters</dt><dd>
  549. <table class="params">
  550. <tr><td class="paramname">client</td><td>The connected MobileBackup client to use. </td></tr>
  551. <tr><td class="paramname">reason</td><td>A string describing the reason for the error message.</td></tr>
  552. </table>
  553. </dd>
  554. </dl>
  555. <dl class="section return"><dt>Returns</dt><dd>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. </dd></dl>
  556. </div>
  557. </div>
  558. <a class="anchor" id="adb1ef11295238147532e84878b924a5e"></a>
  559. <div class="memitem">
  560. <div class="memproto">
  561. <table class="memname">
  562. <tr>
  563. <td class="memname"><a class="el" href="mobilebackup_8h.html#a871f2dcf590edff5b17156a464784e9f">mobilebackup_error_t</a> mobilebackup_send_restore_complete </td>
  564. <td>(</td>
  565. <td class="paramtype"><a class="el" href="mobilebackup_8h.html#a80c8c3310e73ac1ac6cdb565635a9af8">mobilebackup_client_t</a>&#160;</td>
  566. <td class="paramname"><em>client</em></td><td>)</td>
  567. <td></td>
  568. </tr>
  569. </table>
  570. </div><div class="memdoc">
  571. <p>Tells the device that the restore process is complete and waits for the device to close the connection. </p>
  572. <p>After that, the device should reboot.</p>
  573. <dl class="params"><dt>Parameters</dt><dd>
  574. <table class="params">
  575. <tr><td class="paramname">client</td><td>The connected MobileBackup client to use.</td></tr>
  576. </table>
  577. </dd>
  578. </dl>
  579. <dl class="section return"><dt>Returns</dt><dd>MOBILEBACKUP_E_SUCCESS on success, MOBILEBACKUP_E_INVALID_ARG if client is invalid, MOBILEBACKUP_E_PLIST_ERROR if the received disconnect message plist is invalid, or MOBILEBACKUP_E_MUX_ERROR if a communication error occurs. </dd></dl>
  580. </div>
  581. </div>
  582. </div><!-- contents -->
  583. <!-- start footer part -->
  584. <hr class="footer"/><address class="footer"><small>
  585. Generated on Wed Jan 28 2015 23:15:48 for libimobiledevice by &#160;<a href="http://www.doxygen.org/index.html">
  586. <img class="footer" src="doxygen.png" alt="doxygen"/>
  587. </a> 1.8.8
  588. </small></address>
  589. </body>
  590. </html>