summaryrefslogtreecommitdiffstats
path: root/include/libimobiledevice/notification_proxy.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/libimobiledevice/notification_proxy.h')
-rw-r--r--include/libimobiledevice/notification_proxy.h20
1 files changed, 13 insertions, 7 deletions
diff --git a/include/libimobiledevice/notification_proxy.h b/include/libimobiledevice/notification_proxy.h
index a9d2d3f..872692c 100644
--- a/include/libimobiledevice/notification_proxy.h
+++ b/include/libimobiledevice/notification_proxy.h
@@ -31,6 +31,7 @@ extern "C" {
31#include <libimobiledevice/libimobiledevice.h> 31#include <libimobiledevice/libimobiledevice.h>
32#include <libimobiledevice/lockdown.h> 32#include <libimobiledevice/lockdown.h>
33 33
34/** Service identifier passed to lockdownd_start_service() to start the notification proxy service */
34#define NP_SERVICE_NAME "com.apple.mobile.notification_proxy" 35#define NP_SERVICE_NAME "com.apple.mobile.notification_proxy"
35 36
36/** Error Codes */ 37/** Error Codes */
@@ -43,22 +44,26 @@ typedef enum {
43} np_error_t; 44} np_error_t;
44 45
45/** 46/**
46 * @name Notifications that can be send 47 * @name Notifications that can be sent
47 * 48 *
48 * For use with np_post_notification() (client --> device) 49 * For use with np_post_notification() (client --> device)
49 */ 50 */
51/**@{*/
52//! @cond
50#define NP_SYNC_WILL_START "com.apple.itunes-mobdev.syncWillStart" 53#define NP_SYNC_WILL_START "com.apple.itunes-mobdev.syncWillStart"
51#define NP_SYNC_DID_START "com.apple.itunes-mobdev.syncDidStart" 54#define NP_SYNC_DID_START "com.apple.itunes-mobdev.syncDidStart"
52#define NP_SYNC_DID_FINISH "com.apple.itunes-mobdev.syncDidFinish" 55#define NP_SYNC_DID_FINISH "com.apple.itunes-mobdev.syncDidFinish"
53#define NP_SYNC_LOCK_REQUEST "com.apple.itunes-mobdev.syncLockRequest" 56#define NP_SYNC_LOCK_REQUEST "com.apple.itunes-mobdev.syncLockRequest"
54/*@}*/ 57//! @endcond
58/**@}*/
55 59
56/** 60/**
57 * @name Notifications that can be received 61 * @name Notifications that can be received
58 * 62 *
59 * For use with np_observe_notification() (device --> client) 63 * For use with np_observe_notification() (device --> client)
60 */ 64 */
61/*@{*/ 65/**@{*/
66//! @cond
62#define NP_SYNC_CANCEL_REQUEST "com.apple.itunes-client.syncCancelRequest" 67#define NP_SYNC_CANCEL_REQUEST "com.apple.itunes-client.syncCancelRequest"
63#define NP_SYNC_SUSPEND_REQUEST "com.apple.itunes-client.syncSuspendRequest" 68#define NP_SYNC_SUSPEND_REQUEST "com.apple.itunes-client.syncSuspendRequest"
64#define NP_SYNC_RESUME_REQUEST "com.apple.itunes-client.syncResumeRequest" 69#define NP_SYNC_RESUME_REQUEST "com.apple.itunes-client.syncResumeRequest"
@@ -81,12 +86,13 @@ typedef enum {
81#define NP_ITDBPREP_DID_END "com.apple.itdbprep.notification.didEnd" 86#define NP_ITDBPREP_DID_END "com.apple.itdbprep.notification.didEnd"
82#define NP_LANGUAGE_CHANGED "com.apple.language.changed" 87#define NP_LANGUAGE_CHANGED "com.apple.language.changed"
83#define NP_ADDRESS_BOOK_PREF_CHANGED "com.apple.AddressBook.PreferenceChanged" 88#define NP_ADDRESS_BOOK_PREF_CHANGED "com.apple.AddressBook.PreferenceChanged"
84/*@}*/ 89//! @endcond
90/**@}*/
85 91
86typedef struct np_client_private np_client_private; 92typedef struct np_client_private np_client_private; /**< \private */
87typedef np_client_private *np_client_t; /**< The client handle. */ 93typedef np_client_private *np_client_t; /**< The client handle. */
88 94
89/** Reports which notification was received. */ 95/** Callback function that reports which notification was received. */
90typedef void (*np_notify_cb_t) (const char *notification, void *user_data); 96typedef void (*np_notify_cb_t) (const char *notification, void *user_data);
91 97
92/* Interface */ 98/* Interface */
@@ -177,7 +183,7 @@ np_error_t np_observe_notifications(np_client_t client, const char **notificatio
177 * @param client the NP client 183 * @param client the NP client
178 * @param notify_cb pointer to a callback function or NULL to de-register a 184 * @param notify_cb pointer to a callback function or NULL to de-register a
179 * previously set callback function. 185 * previously set callback function.
180 * @param user_data Pointer that will be passed to the callback function as 186 * @param userdata Pointer that will be passed to the callback function as
181 * user data. If notify_cb is NULL, this parameter is ignored. 187 * user data. If notify_cb is NULL, this parameter is ignored.
182 * 188 *
183 * @note Only one callback function can be registered at the same time; 189 * @note Only one callback function can be registered at the same time;