notification__proxy_8h.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514
  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/notification_proxy.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">notification_proxy.h File Reference</div> </div>
  56. </div><!--header-->
  57. <div class="contents">
  58. <p>Observe and post notifications.
  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:a3e49cd253b880e6ca39009de3650c4a6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3e49cd253b880e6ca39009de3650c4a6"></a>
  64. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_SERVICE_NAME</b>&#160;&#160;&#160;&quot;com.apple.mobile.notification_proxy&quot;</td></tr>
  65. <tr class="separator:a3e49cd253b880e6ca39009de3650c4a6"><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:ad049933784d49e2c03997ab0efee0c4d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad049933784d49e2c03997ab0efee0c4d"></a>
  70. typedef struct np_client_private&#160;</td><td class="memItemRight" valign="bottom"><b>np_client_private</b></td></tr>
  71. <tr class="separator:ad049933784d49e2c03997ab0efee0c4d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  72. <tr class="memitem:ac70ac0a2cdf28fe43b181c8e8b4a900e"><td class="memItemLeft" align="right" valign="top">typedef np_client_private *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="notification__proxy_8h.html#ac70ac0a2cdf28fe43b181c8e8b4a900e">np_client_t</a></td></tr>
  73. <tr class="memdesc:ac70ac0a2cdf28fe43b181c8e8b4a900e"><td class="mdescLeft">&#160;</td><td class="mdescRight">The client handle. <a href="#ac70ac0a2cdf28fe43b181c8e8b4a900e">More...</a><br /></td></tr>
  74. <tr class="separator:ac70ac0a2cdf28fe43b181c8e8b4a900e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  75. <tr class="memitem:a95bcfe5738db77644c890df3045a9127"><td class="memItemLeft" align="right" valign="top">typedef void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="notification__proxy_8h.html#a95bcfe5738db77644c890df3045a9127">np_notify_cb_t</a> )(const char *notification, void *user_data)</td></tr>
  76. <tr class="memdesc:a95bcfe5738db77644c890df3045a9127"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reports which notification was received. <a href="#a95bcfe5738db77644c890df3045a9127">More...</a><br /></td></tr>
  77. <tr class="separator:a95bcfe5738db77644c890df3045a9127"><td class="memSeparator" colspan="2">&#160;</td></tr>
  78. </table><table class="memberdecls">
  79. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
  80. Enumerations</h2></td></tr>
  81. <tr class="memitem:a03476b5a1090af7a620154ae5694328e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a03476b5a1090af7a620154ae5694328e"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="notification__proxy_8h.html#a03476b5a1090af7a620154ae5694328e">np_error_t</a> { <br />
  82. &#160;&#160;<b>NP_E_SUCCESS</b> = 0,
  83. <br />
  84. &#160;&#160;<b>NP_E_INVALID_ARG</b> = -1,
  85. <br />
  86. &#160;&#160;<b>NP_E_PLIST_ERROR</b> = -2,
  87. <br />
  88. &#160;&#160;<b>NP_E_CONN_FAILED</b> = -3,
  89. <br />
  90. &#160;&#160;<b>NP_E_UNKNOWN_ERROR</b> = -256
  91. <br />
  92. }</td></tr>
  93. <tr class="memdesc:a03476b5a1090af7a620154ae5694328e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Error Codes. <br /></td></tr>
  94. <tr class="separator:a03476b5a1090af7a620154ae5694328e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  95. </table><table class="memberdecls">
  96. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  97. Functions</h2></td></tr>
  98. <tr class="memitem:afbdec86ad31d32cc04240a1e26ae0987"><td class="memItemLeft" align="right" valign="top"><a class="el" href="notification__proxy_8h.html#a03476b5a1090af7a620154ae5694328e">np_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="notification__proxy_8h.html#afbdec86ad31d32cc04240a1e26ae0987">np_client_new</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, lockdownd_service_descriptor_t service, <a class="el" href="notification__proxy_8h.html#ac70ac0a2cdf28fe43b181c8e8b4a900e">np_client_t</a> *client)</td></tr>
  99. <tr class="memdesc:afbdec86ad31d32cc04240a1e26ae0987"><td class="mdescLeft">&#160;</td><td class="mdescRight">Connects to the notification_proxy on the specified device. <a href="#afbdec86ad31d32cc04240a1e26ae0987">More...</a><br /></td></tr>
  100. <tr class="separator:afbdec86ad31d32cc04240a1e26ae0987"><td class="memSeparator" colspan="2">&#160;</td></tr>
  101. <tr class="memitem:ad4e29a62a989b6e6846321e96fe0bd98"><td class="memItemLeft" align="right" valign="top"><a class="el" href="notification__proxy_8h.html#a03476b5a1090af7a620154ae5694328e">np_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="notification__proxy_8h.html#ad4e29a62a989b6e6846321e96fe0bd98">np_client_start_service</a> (<a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a> device, <a class="el" href="notification__proxy_8h.html#ac70ac0a2cdf28fe43b181c8e8b4a900e">np_client_t</a> *client, const char *label)</td></tr>
  102. <tr class="memdesc:ad4e29a62a989b6e6846321e96fe0bd98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts a new notification proxy service on the specified device and connects to it. <a href="#ad4e29a62a989b6e6846321e96fe0bd98">More...</a><br /></td></tr>
  103. <tr class="separator:ad4e29a62a989b6e6846321e96fe0bd98"><td class="memSeparator" colspan="2">&#160;</td></tr>
  104. <tr class="memitem:a3b826727555eee0c2b89b35043b3a5ad"><td class="memItemLeft" align="right" valign="top"><a class="el" href="notification__proxy_8h.html#a03476b5a1090af7a620154ae5694328e">np_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="notification__proxy_8h.html#a3b826727555eee0c2b89b35043b3a5ad">np_client_free</a> (<a class="el" href="notification__proxy_8h.html#ac70ac0a2cdf28fe43b181c8e8b4a900e">np_client_t</a> client)</td></tr>
  105. <tr class="memdesc:a3b826727555eee0c2b89b35043b3a5ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disconnects a notification_proxy client from the device and frees up the notification_proxy client data. <a href="#a3b826727555eee0c2b89b35043b3a5ad">More...</a><br /></td></tr>
  106. <tr class="separator:a3b826727555eee0c2b89b35043b3a5ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
  107. <tr class="memitem:aaf9e13148414a15028ce3cc2f35c9d5c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="notification__proxy_8h.html#a03476b5a1090af7a620154ae5694328e">np_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="notification__proxy_8h.html#aaf9e13148414a15028ce3cc2f35c9d5c">np_post_notification</a> (<a class="el" href="notification__proxy_8h.html#ac70ac0a2cdf28fe43b181c8e8b4a900e">np_client_t</a> client, const char *notification)</td></tr>
  108. <tr class="memdesc:aaf9e13148414a15028ce3cc2f35c9d5c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends a notification to the device's notification_proxy. <a href="#aaf9e13148414a15028ce3cc2f35c9d5c">More...</a><br /></td></tr>
  109. <tr class="separator:aaf9e13148414a15028ce3cc2f35c9d5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  110. <tr class="memitem:a6965819188aea0c0053d4d48c489254c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="notification__proxy_8h.html#a03476b5a1090af7a620154ae5694328e">np_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="notification__proxy_8h.html#a6965819188aea0c0053d4d48c489254c">np_observe_notification</a> (<a class="el" href="notification__proxy_8h.html#ac70ac0a2cdf28fe43b181c8e8b4a900e">np_client_t</a> client, const char *notification)</td></tr>
  111. <tr class="memdesc:a6965819188aea0c0053d4d48c489254c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tells the device to send a notification on the specified event. <a href="#a6965819188aea0c0053d4d48c489254c">More...</a><br /></td></tr>
  112. <tr class="separator:a6965819188aea0c0053d4d48c489254c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  113. <tr class="memitem:ab36d06352c3a171965a62efbd884b9c3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="notification__proxy_8h.html#a03476b5a1090af7a620154ae5694328e">np_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="notification__proxy_8h.html#ab36d06352c3a171965a62efbd884b9c3">np_observe_notifications</a> (<a class="el" href="notification__proxy_8h.html#ac70ac0a2cdf28fe43b181c8e8b4a900e">np_client_t</a> client, const char **notification_spec)</td></tr>
  114. <tr class="memdesc:ab36d06352c3a171965a62efbd884b9c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Tells the device to send a notification on specified events. <a href="#ab36d06352c3a171965a62efbd884b9c3">More...</a><br /></td></tr>
  115. <tr class="separator:ab36d06352c3a171965a62efbd884b9c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  116. <tr class="memitem:a7e71481884faa8e6c8893c93c3ad3862"><td class="memItemLeft" align="right" valign="top"><a class="el" href="notification__proxy_8h.html#a03476b5a1090af7a620154ae5694328e">np_error_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="notification__proxy_8h.html#a7e71481884faa8e6c8893c93c3ad3862">np_set_notify_callback</a> (<a class="el" href="notification__proxy_8h.html#ac70ac0a2cdf28fe43b181c8e8b4a900e">np_client_t</a> client, <a class="el" href="notification__proxy_8h.html#a95bcfe5738db77644c890df3045a9127">np_notify_cb_t</a> notify_cb, void *userdata)</td></tr>
  117. <tr class="memdesc:a7e71481884faa8e6c8893c93c3ad3862"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function allows an application to define a callback function that will be called when a notification has been received. <a href="#a7e71481884faa8e6c8893c93c3ad3862">More...</a><br /></td></tr>
  118. <tr class="separator:a7e71481884faa8e6c8893c93c3ad3862"><td class="memSeparator" colspan="2">&#160;</td></tr>
  119. </table><table class="memberdecls">
  120. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  121. Notifications that can be send</h2></td></tr>
  122. <tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpf1f7a62e53dd62addbf606b97f910799"></a>For use with <a class="el" href="notification__proxy_8h.html#aaf9e13148414a15028ce3cc2f35c9d5c" title="Sends a notification to the device&#39;s notification_proxy. ">np_post_notification()</a> (client &ndash;&gt; device) </p>
  123. </td></tr>
  124. <tr class="memitem:a9db1a941472487f4d58d5a054058fcbe"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9db1a941472487f4d58d5a054058fcbe"></a>
  125. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_SYNC_WILL_START</b>&#160;&#160;&#160;&quot;com.apple.itunes-mobdev.syncWillStart&quot;</td></tr>
  126. <tr class="separator:a9db1a941472487f4d58d5a054058fcbe"><td class="memSeparator" colspan="2">&#160;</td></tr>
  127. <tr class="memitem:ad3023cbece42b5c27d3fd19bf56ce52a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad3023cbece42b5c27d3fd19bf56ce52a"></a>
  128. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_SYNC_DID_START</b>&#160;&#160;&#160;&quot;com.apple.itunes-mobdev.syncDidStart&quot;</td></tr>
  129. <tr class="separator:ad3023cbece42b5c27d3fd19bf56ce52a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  130. <tr class="memitem:ae14ab9de0ea68ec4820d7d2521af05a5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae14ab9de0ea68ec4820d7d2521af05a5"></a>
  131. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_SYNC_DID_FINISH</b>&#160;&#160;&#160;&quot;com.apple.itunes-mobdev.syncDidFinish&quot;</td></tr>
  132. <tr class="separator:ae14ab9de0ea68ec4820d7d2521af05a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
  133. <tr class="memitem:ae9bbd7a8f148d35b81f6436f1df89344"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae9bbd7a8f148d35b81f6436f1df89344"></a>
  134. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_SYNC_LOCK_REQUEST</b>&#160;&#160;&#160;&quot;com.apple.itunes-mobdev.syncLockRequest&quot;</td></tr>
  135. <tr class="separator:ae9bbd7a8f148d35b81f6436f1df89344"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. </table><table class="memberdecls">
  137. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
  138. Notifications that can be received</h2></td></tr>
  139. <tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpb0930d960d0e39b68aa7240c2eb492d7"></a>For use with <a class="el" href="notification__proxy_8h.html#a6965819188aea0c0053d4d48c489254c" title="Tells the device to send a notification on the specified event. ">np_observe_notification()</a> (device &ndash;&gt; client) </p>
  140. </td></tr>
  141. <tr class="memitem:a829c5ba5c8192b86b049822d4c512a49"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a829c5ba5c8192b86b049822d4c512a49"></a>
  142. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_SYNC_CANCEL_REQUEST</b>&#160;&#160;&#160;&quot;com.apple.itunes-client.syncCancelRequest&quot;</td></tr>
  143. <tr class="separator:a829c5ba5c8192b86b049822d4c512a49"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a8fa51f1a0aacc0fb5e62cb33ef4cae72"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8fa51f1a0aacc0fb5e62cb33ef4cae72"></a>
  145. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_SYNC_SUSPEND_REQUEST</b>&#160;&#160;&#160;&quot;com.apple.itunes-client.syncSuspendRequest&quot;</td></tr>
  146. <tr class="separator:a8fa51f1a0aacc0fb5e62cb33ef4cae72"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a91ec1bb5a80ed75b2b64c305ff9279b7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a91ec1bb5a80ed75b2b64c305ff9279b7"></a>
  148. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_SYNC_RESUME_REQUEST</b>&#160;&#160;&#160;&quot;com.apple.itunes-client.syncResumeRequest&quot;</td></tr>
  149. <tr class="separator:a91ec1bb5a80ed75b2b64c305ff9279b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a2cc4d7d01ee5cfd35fb16bfe5bbf7a9c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2cc4d7d01ee5cfd35fb16bfe5bbf7a9c"></a>
  151. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_PHONE_NUMBER_CHANGED</b>&#160;&#160;&#160;&quot;com.apple.mobile.lockdown.phone_number_changed&quot;</td></tr>
  152. <tr class="separator:a2cc4d7d01ee5cfd35fb16bfe5bbf7a9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:ad2ddd08f7b570624d2d06d4010c783a0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad2ddd08f7b570624d2d06d4010c783a0"></a>
  154. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_DEVICE_NAME_CHANGED</b>&#160;&#160;&#160;&quot;com.apple.mobile.lockdown.device_name_changed&quot;</td></tr>
  155. <tr class="separator:ad2ddd08f7b570624d2d06d4010c783a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:a00712d5ef259dd2ae9a3c3fc75202e89"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a00712d5ef259dd2ae9a3c3fc75202e89"></a>
  157. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_TIMEZONE_CHANGED</b>&#160;&#160;&#160;&quot;com.apple.mobile.lockdown.timezone_changed&quot;</td></tr>
  158. <tr class="separator:a00712d5ef259dd2ae9a3c3fc75202e89"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:a878e7e86e0d90ec4d5d79c8c15053ae3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a878e7e86e0d90ec4d5d79c8c15053ae3"></a>
  160. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_TRUSTED_HOST_ATTACHED</b>&#160;&#160;&#160;&quot;com.apple.mobile.lockdown.trusted_host_attached&quot;</td></tr>
  161. <tr class="separator:a878e7e86e0d90ec4d5d79c8c15053ae3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:ab2e7e081bc0cdaadb97973aea46498fc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2e7e081bc0cdaadb97973aea46498fc"></a>
  163. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_HOST_DETACHED</b>&#160;&#160;&#160;&quot;com.apple.mobile.lockdown.host_detached&quot;</td></tr>
  164. <tr class="separator:ab2e7e081bc0cdaadb97973aea46498fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:ab4689021a0d94b61c78fe72cb31df195"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab4689021a0d94b61c78fe72cb31df195"></a>
  166. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_HOST_ATTACHED</b>&#160;&#160;&#160;&quot;com.apple.mobile.lockdown.host_attached&quot;</td></tr>
  167. <tr class="separator:ab4689021a0d94b61c78fe72cb31df195"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. <tr class="memitem:a349161233cff5ade293fb0574d9c1ba2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a349161233cff5ade293fb0574d9c1ba2"></a>
  169. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_REGISTRATION_FAILED</b>&#160;&#160;&#160;&quot;com.apple.mobile.lockdown.registration_failed&quot;</td></tr>
  170. <tr class="separator:a349161233cff5ade293fb0574d9c1ba2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  171. <tr class="memitem:a2fae14b7cf3678cd1b56194daba58058"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2fae14b7cf3678cd1b56194daba58058"></a>
  172. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_ACTIVATION_STATE</b>&#160;&#160;&#160;&quot;com.apple.mobile.lockdown.activation_state&quot;</td></tr>
  173. <tr class="separator:a2fae14b7cf3678cd1b56194daba58058"><td class="memSeparator" colspan="2">&#160;</td></tr>
  174. <tr class="memitem:a30ec5e2a07ae42673ea3abac2d72cb0a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a30ec5e2a07ae42673ea3abac2d72cb0a"></a>
  175. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_BRICK_STATE</b>&#160;&#160;&#160;&quot;com.apple.mobile.lockdown.brick_state&quot;</td></tr>
  176. <tr class="separator:a30ec5e2a07ae42673ea3abac2d72cb0a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  177. <tr class="memitem:a771f707ce667d75072a191f1f4d1b32b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a771f707ce667d75072a191f1f4d1b32b"></a>
  178. #define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="notification__proxy_8h.html#a771f707ce667d75072a191f1f4d1b32b">NP_DISK_USAGE_CHANGED</a>&#160;&#160;&#160;&quot;com.apple.mobile.lockdown.disk_usage_changed&quot;</td></tr>
  179. <tr class="memdesc:a771f707ce667d75072a191f1f4d1b32b"><td class="mdescLeft">&#160;</td><td class="mdescRight">iOS 4.0+ <br /></td></tr>
  180. <tr class="separator:a771f707ce667d75072a191f1f4d1b32b"><td class="memSeparator" colspan="2">&#160;</td></tr>
  181. <tr class="memitem:a974e97517ebccf59e43cf7ace19447a6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a974e97517ebccf59e43cf7ace19447a6"></a>
  182. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_DS_DOMAIN_CHANGED</b>&#160;&#160;&#160;&quot;com.apple.mobile.data_sync.domain_changed&quot;</td></tr>
  183. <tr class="separator:a974e97517ebccf59e43cf7ace19447a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  184. <tr class="memitem:a66bc93162ae3ab3a387bd2acd69534d1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a66bc93162ae3ab3a387bd2acd69534d1"></a>
  185. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_BACKUP_DOMAIN_CHANGED</b>&#160;&#160;&#160;&quot;com.apple.mobile.backup.domain_changed&quot;</td></tr>
  186. <tr class="separator:a66bc93162ae3ab3a387bd2acd69534d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  187. <tr class="memitem:a8f22396a2180b67b0a3c2c98d65714fd"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8f22396a2180b67b0a3c2c98d65714fd"></a>
  188. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_APP_INSTALLED</b>&#160;&#160;&#160;&quot;com.apple.mobile.application_installed&quot;</td></tr>
  189. <tr class="separator:a8f22396a2180b67b0a3c2c98d65714fd"><td class="memSeparator" colspan="2">&#160;</td></tr>
  190. <tr class="memitem:adb18083b1e8c2513c4c0f68f3d89cb01"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adb18083b1e8c2513c4c0f68f3d89cb01"></a>
  191. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_APP_UNINSTALLED</b>&#160;&#160;&#160;&quot;com.apple.mobile.application_uninstalled&quot;</td></tr>
  192. <tr class="separator:adb18083b1e8c2513c4c0f68f3d89cb01"><td class="memSeparator" colspan="2">&#160;</td></tr>
  193. <tr class="memitem:a3fc34c861c328f038c1c2cac40132f41"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3fc34c861c328f038c1c2cac40132f41"></a>
  194. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_DEV_IMAGE_MOUNTED</b>&#160;&#160;&#160;&quot;com.apple.mobile.developer_image_mounted&quot;</td></tr>
  195. <tr class="separator:a3fc34c861c328f038c1c2cac40132f41"><td class="memSeparator" colspan="2">&#160;</td></tr>
  196. <tr class="memitem:a67ab24b9735b9736484af892b09338c3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67ab24b9735b9736484af892b09338c3"></a>
  197. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_ATTEMPTACTIVATION</b>&#160;&#160;&#160;&quot;com.apple.springboard.attemptactivation&quot;</td></tr>
  198. <tr class="separator:a67ab24b9735b9736484af892b09338c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  199. <tr class="memitem:ab9744cc75dc13ba773cbaf7b772aaed2"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab9744cc75dc13ba773cbaf7b772aaed2"></a>
  200. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_ITDBPREP_DID_END</b>&#160;&#160;&#160;&quot;com.apple.itdbprep.notification.didEnd&quot;</td></tr>
  201. <tr class="separator:ab9744cc75dc13ba773cbaf7b772aaed2"><td class="memSeparator" colspan="2">&#160;</td></tr>
  202. <tr class="memitem:a05be23ad6706c8af38ad90d7582fd3f3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a05be23ad6706c8af38ad90d7582fd3f3"></a>
  203. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_LANGUAGE_CHANGED</b>&#160;&#160;&#160;&quot;com.apple.language.changed&quot;</td></tr>
  204. <tr class="separator:a05be23ad6706c8af38ad90d7582fd3f3"><td class="memSeparator" colspan="2">&#160;</td></tr>
  205. <tr class="memitem:a2674ab39218a0f506660f8fc0cf9ae1c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2674ab39218a0f506660f8fc0cf9ae1c"></a>
  206. #define&#160;</td><td class="memItemRight" valign="bottom"><b>NP_ADDRESS_BOOK_PREF_CHANGED</b>&#160;&#160;&#160;&quot;com.apple.AddressBook.PreferenceChanged&quot;</td></tr>
  207. <tr class="separator:a2674ab39218a0f506660f8fc0cf9ae1c"><td class="memSeparator" colspan="2">&#160;</td></tr>
  208. </table>
  209. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  210. <div class="textblock"><p>Observe and post notifications. </p>
  211. </div><h2 class="groupheader">Typedef Documentation</h2>
  212. <a class="anchor" id="ac70ac0a2cdf28fe43b181c8e8b4a900e"></a>
  213. <div class="memitem">
  214. <div class="memproto">
  215. <table class="memname">
  216. <tr>
  217. <td class="memname">typedef np_client_private* <a class="el" href="notification__proxy_8h.html#ac70ac0a2cdf28fe43b181c8e8b4a900e">np_client_t</a></td>
  218. </tr>
  219. </table>
  220. </div><div class="memdoc">
  221. <p>The client handle. </p>
  222. </div>
  223. </div>
  224. <a class="anchor" id="a95bcfe5738db77644c890df3045a9127"></a>
  225. <div class="memitem">
  226. <div class="memproto">
  227. <table class="memname">
  228. <tr>
  229. <td class="memname">typedef void(* np_notify_cb_t)(const char *notification, void *user_data)</td>
  230. </tr>
  231. </table>
  232. </div><div class="memdoc">
  233. <p>Reports which notification was received. </p>
  234. </div>
  235. </div>
  236. <h2 class="groupheader">Function Documentation</h2>
  237. <a class="anchor" id="a3b826727555eee0c2b89b35043b3a5ad"></a>
  238. <div class="memitem">
  239. <div class="memproto">
  240. <table class="memname">
  241. <tr>
  242. <td class="memname"><a class="el" href="notification__proxy_8h.html#a03476b5a1090af7a620154ae5694328e">np_error_t</a> np_client_free </td>
  243. <td>(</td>
  244. <td class="paramtype"><a class="el" href="notification__proxy_8h.html#ac70ac0a2cdf28fe43b181c8e8b4a900e">np_client_t</a>&#160;</td>
  245. <td class="paramname"><em>client</em></td><td>)</td>
  246. <td></td>
  247. </tr>
  248. </table>
  249. </div><div class="memdoc">
  250. <p>Disconnects a notification_proxy client from the device and frees up the notification_proxy client data. </p>
  251. <dl class="params"><dt>Parameters</dt><dd>
  252. <table class="params">
  253. <tr><td class="paramname">client</td><td>The notification_proxy client to disconnect and free.</td></tr>
  254. </table>
  255. </dd>
  256. </dl>
  257. <dl class="section return"><dt>Returns</dt><dd>NP_E_SUCCESS on success, or NP_E_INVALID_ARG when client is NULL. </dd></dl>
  258. </div>
  259. </div>
  260. <a class="anchor" id="afbdec86ad31d32cc04240a1e26ae0987"></a>
  261. <div class="memitem">
  262. <div class="memproto">
  263. <table class="memname">
  264. <tr>
  265. <td class="memname"><a class="el" href="notification__proxy_8h.html#a03476b5a1090af7a620154ae5694328e">np_error_t</a> np_client_new </td>
  266. <td>(</td>
  267. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
  268. <td class="paramname"><em>device</em>, </td>
  269. </tr>
  270. <tr>
  271. <td class="paramkey"></td>
  272. <td></td>
  273. <td class="paramtype">lockdownd_service_descriptor_t&#160;</td>
  274. <td class="paramname"><em>service</em>, </td>
  275. </tr>
  276. <tr>
  277. <td class="paramkey"></td>
  278. <td></td>
  279. <td class="paramtype"><a class="el" href="notification__proxy_8h.html#ac70ac0a2cdf28fe43b181c8e8b4a900e">np_client_t</a> *&#160;</td>
  280. <td class="paramname"><em>client</em>&#160;</td>
  281. </tr>
  282. <tr>
  283. <td></td>
  284. <td>)</td>
  285. <td></td><td></td>
  286. </tr>
  287. </table>
  288. </div><div class="memdoc">
  289. <p>Connects to the notification_proxy on the specified device. </p>
  290. <dl class="params"><dt>Parameters</dt><dd>
  291. <table class="params">
  292. <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
  293. <tr><td class="paramname">service</td><td>The service descriptor returned by lockdownd_start_service. </td></tr>
  294. <tr><td class="paramname">client</td><td>Pointer that will be set to a newly allocated np_client_t upon successful return.</td></tr>
  295. </table>
  296. </dd>
  297. </dl>
  298. <dl class="section return"><dt>Returns</dt><dd>NP_E_SUCCESS on success, NP_E_INVALID_ARG when device is NULL, or NP_E_CONN_FAILED when the connection to the device could not be established. </dd></dl>
  299. </div>
  300. </div>
  301. <a class="anchor" id="ad4e29a62a989b6e6846321e96fe0bd98"></a>
  302. <div class="memitem">
  303. <div class="memproto">
  304. <table class="memname">
  305. <tr>
  306. <td class="memname"><a class="el" href="notification__proxy_8h.html#a03476b5a1090af7a620154ae5694328e">np_error_t</a> np_client_start_service </td>
  307. <td>(</td>
  308. <td class="paramtype"><a class="el" href="libimobiledevice_8h.html#ae5bc0e9aa2f3b5023755f5e1c5039a60">idevice_t</a>&#160;</td>
  309. <td class="paramname"><em>device</em>, </td>
  310. </tr>
  311. <tr>
  312. <td class="paramkey"></td>
  313. <td></td>
  314. <td class="paramtype"><a class="el" href="notification__proxy_8h.html#ac70ac0a2cdf28fe43b181c8e8b4a900e">np_client_t</a> *&#160;</td>
  315. <td class="paramname"><em>client</em>, </td>
  316. </tr>
  317. <tr>
  318. <td class="paramkey"></td>
  319. <td></td>
  320. <td class="paramtype">const char *&#160;</td>
  321. <td class="paramname"><em>label</em>&#160;</td>
  322. </tr>
  323. <tr>
  324. <td></td>
  325. <td>)</td>
  326. <td></td><td></td>
  327. </tr>
  328. </table>
  329. </div><div class="memdoc">
  330. <p>Starts a new notification proxy service on the specified device and connects to it. </p>
  331. <dl class="params"><dt>Parameters</dt><dd>
  332. <table class="params">
  333. <tr><td class="paramname">device</td><td>The device to connect to. </td></tr>
  334. <tr><td class="paramname">client</td><td>Pointer that will point to a newly allocated np_client_t upon successful return. Must be freed using <a class="el" href="notification__proxy_8h.html#a3b826727555eee0c2b89b35043b3a5ad" title="Disconnects a notification_proxy client from the device and frees up the notification_proxy client da...">np_client_free()</a> after use. </td></tr>
  335. <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>
  336. </table>
  337. </dd>
  338. </dl>
  339. <dl class="section return"><dt>Returns</dt><dd>NP_E_SUCCESS on success, or an NP_E_* error code otherwise. </dd></dl>
  340. </div>
  341. </div>
  342. <a class="anchor" id="a6965819188aea0c0053d4d48c489254c"></a>
  343. <div class="memitem">
  344. <div class="memproto">
  345. <table class="memname">
  346. <tr>
  347. <td class="memname"><a class="el" href="notification__proxy_8h.html#a03476b5a1090af7a620154ae5694328e">np_error_t</a> np_observe_notification </td>
  348. <td>(</td>
  349. <td class="paramtype"><a class="el" href="notification__proxy_8h.html#ac70ac0a2cdf28fe43b181c8e8b4a900e">np_client_t</a>&#160;</td>
  350. <td class="paramname"><em>client</em>, </td>
  351. </tr>
  352. <tr>
  353. <td class="paramkey"></td>
  354. <td></td>
  355. <td class="paramtype">const char *&#160;</td>
  356. <td class="paramname"><em>notification</em>&#160;</td>
  357. </tr>
  358. <tr>
  359. <td></td>
  360. <td>)</td>
  361. <td></td><td></td>
  362. </tr>
  363. </table>
  364. </div><div class="memdoc">
  365. <p>Tells the device to send a notification on the specified event. </p>
  366. <dl class="params"><dt>Parameters</dt><dd>
  367. <table class="params">
  368. <tr><td class="paramname">client</td><td>The client to send to </td></tr>
  369. <tr><td class="paramname">notification</td><td>The notifications that should be observed.</td></tr>
  370. </table>
  371. </dd>
  372. </dl>
  373. <dl class="section return"><dt>Returns</dt><dd>NP_E_SUCCESS on success, NP_E_INVALID_ARG when client or notification are NULL, or an error returned by np_plist_send. </dd></dl>
  374. </div>
  375. </div>
  376. <a class="anchor" id="ab36d06352c3a171965a62efbd884b9c3"></a>
  377. <div class="memitem">
  378. <div class="memproto">
  379. <table class="memname">
  380. <tr>
  381. <td class="memname"><a class="el" href="notification__proxy_8h.html#a03476b5a1090af7a620154ae5694328e">np_error_t</a> np_observe_notifications </td>
  382. <td>(</td>
  383. <td class="paramtype"><a class="el" href="notification__proxy_8h.html#ac70ac0a2cdf28fe43b181c8e8b4a900e">np_client_t</a>&#160;</td>
  384. <td class="paramname"><em>client</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>notification_spec</em>&#160;</td>
  391. </tr>
  392. <tr>
  393. <td></td>
  394. <td>)</td>
  395. <td></td><td></td>
  396. </tr>
  397. </table>
  398. </div><div class="memdoc">
  399. <p>Tells the device to send a notification on specified events. </p>
  400. <dl class="params"><dt>Parameters</dt><dd>
  401. <table class="params">
  402. <tr><td class="paramname">client</td><td>The client to send to </td></tr>
  403. <tr><td class="paramname">notification_spec</td><td>Specification of the notifications that should be observed. This is expected to be an array of const char* that MUST have a terminating NULL entry.</td></tr>
  404. </table>
  405. </dd>
  406. </dl>
  407. <dl class="section return"><dt>Returns</dt><dd>NP_E_SUCCESS on success, NP_E_INVALID_ARG when client is null, or an error returned by np_observe_notification. </dd></dl>
  408. </div>
  409. </div>
  410. <a class="anchor" id="aaf9e13148414a15028ce3cc2f35c9d5c"></a>
  411. <div class="memitem">
  412. <div class="memproto">
  413. <table class="memname">
  414. <tr>
  415. <td class="memname"><a class="el" href="notification__proxy_8h.html#a03476b5a1090af7a620154ae5694328e">np_error_t</a> np_post_notification </td>
  416. <td>(</td>
  417. <td class="paramtype"><a class="el" href="notification__proxy_8h.html#ac70ac0a2cdf28fe43b181c8e8b4a900e">np_client_t</a>&#160;</td>
  418. <td class="paramname"><em>client</em>, </td>
  419. </tr>
  420. <tr>
  421. <td class="paramkey"></td>
  422. <td></td>
  423. <td class="paramtype">const char *&#160;</td>
  424. <td class="paramname"><em>notification</em>&#160;</td>
  425. </tr>
  426. <tr>
  427. <td></td>
  428. <td>)</td>
  429. <td></td><td></td>
  430. </tr>
  431. </table>
  432. </div><div class="memdoc">
  433. <p>Sends a notification to the device's notification_proxy. </p>
  434. <dl class="params"><dt>Parameters</dt><dd>
  435. <table class="params">
  436. <tr><td class="paramname">client</td><td>The client to send to </td></tr>
  437. <tr><td class="paramname">notification</td><td>The notification message to send</td></tr>
  438. </table>
  439. </dd>
  440. </dl>
  441. <dl class="section return"><dt>Returns</dt><dd>NP_E_SUCCESS on success, or an error returned by np_plist_send </dd></dl>
  442. </div>
  443. </div>
  444. <a class="anchor" id="a7e71481884faa8e6c8893c93c3ad3862"></a>
  445. <div class="memitem">
  446. <div class="memproto">
  447. <table class="memname">
  448. <tr>
  449. <td class="memname"><a class="el" href="notification__proxy_8h.html#a03476b5a1090af7a620154ae5694328e">np_error_t</a> np_set_notify_callback </td>
  450. <td>(</td>
  451. <td class="paramtype"><a class="el" href="notification__proxy_8h.html#ac70ac0a2cdf28fe43b181c8e8b4a900e">np_client_t</a>&#160;</td>
  452. <td class="paramname"><em>client</em>, </td>
  453. </tr>
  454. <tr>
  455. <td class="paramkey"></td>
  456. <td></td>
  457. <td class="paramtype"><a class="el" href="notification__proxy_8h.html#a95bcfe5738db77644c890df3045a9127">np_notify_cb_t</a>&#160;</td>
  458. <td class="paramname"><em>notify_cb</em>, </td>
  459. </tr>
  460. <tr>
  461. <td class="paramkey"></td>
  462. <td></td>
  463. <td class="paramtype">void *&#160;</td>
  464. <td class="paramname"><em>userdata</em>&#160;</td>
  465. </tr>
  466. <tr>
  467. <td></td>
  468. <td>)</td>
  469. <td></td><td></td>
  470. </tr>
  471. </table>
  472. </div><div class="memdoc">
  473. <p>This function allows an application to define a callback function that will be called when a notification has been received. </p>
  474. <p>It will start a thread that polls for notifications and calls the callback function if a notification has been received. In case of an error condition when polling for notifications - e.g. device disconnect - the thread will call the callback function with an empty notification "" and terminate itself.</p>
  475. <dl class="params"><dt>Parameters</dt><dd>
  476. <table class="params">
  477. <tr><td class="paramname">client</td><td>the NP client </td></tr>
  478. <tr><td class="paramname">notify_cb</td><td>pointer to a callback function or NULL to de-register a previously set callback function. </td></tr>
  479. <tr><td class="paramname">user_data</td><td>Pointer that will be passed to the callback function as user data. If notify_cb is NULL, this parameter is ignored.</td></tr>
  480. </table>
  481. </dd>
  482. </dl>
  483. <dl class="section note"><dt>Note</dt><dd>Only one callback function can be registered at the same time; any previously set callback function will be removed automatically.</dd></dl>
  484. <dl class="section return"><dt>Returns</dt><dd>NP_E_SUCCESS when the callback was successfully registered, NP_E_INVALID_ARG when client is NULL, or NP_E_UNKNOWN_ERROR when the callback thread could no be created. </dd></dl>
  485. </div>
  486. </div>
  487. </div><!-- contents -->
  488. <!-- start footer part -->
  489. <hr class="footer"/><address class="footer"><small>
  490. Generated on Wed Jan 28 2015 23:15:48 for libimobiledevice by &#160;<a href="http://www.doxygen.org/index.html">
  491. <img class="footer" src="doxygen.png" alt="doxygen"/>
  492. </a> 1.8.8
  493. </small></address>
  494. </body>
  495. </html>