| Framework | /System/Library/Frameworks/SyncServices.framework |
| Availability | Available in Mac OS X v10.4 and later. |
| Companion guide | |
| Declared in | ISyncSessionDriver.h |
This is an informal protocol for the delegates of an ISyncSessionDriver object. You can optionally implement any of these methods to augment the behavior of a sync session. By implementing these methods, you can intervene before and after most phases of a sync session.
– sessionDriver:didRegisterClientAndReturnError: required method
– sessionDriver:willPushAndReturnError: required method
– sessionDriver:didPushAndReturnError: required method
– sessionDriver:willPullAndReturnError: required method
– sessionDriver:didPullAndReturnError: required method
– sessionDriver:willFinishSessionAndReturnError: required method
– sessionDriverDidFinishSession: required method
– sessionDriverWillCancelSession: required method
– sessionDriverDidCancelSession: required method
– sessionDriver:willNegotiateAndReturnError: required method
– sessionDriver:didNegotiateAndReturnError: required method
– sessionDriver:didReceiveSyncAlertAndReturnError: required method
Informs the receiver that the client did negotiate with the sync engine. (required)
- (BOOL)sessionDriver:(ISyncSessionDriver *)sender didNegotiateAndReturnError:(NSError **)outError
The object sending this message.
An error if it occurs.
NO if an error occurs and outError is set to an NSError object that describes the error; otherwise, YES.
ISyncSessionDriver.hInforms the receiver that changes were pulled from the sync engine. (required)
- (BOOL)sessionDriver:(ISyncSessionDriver *)sender didPullAndReturnError:(NSError **)outError
If an error occurs, this method returns NO and sets outError to an NSError object that describes the error.
ISyncSessionDriver.hInforms the receiver that client changes were pushed to the sync engine. (required)
- (BOOL)sessionDriver:(ISyncSessionDriver *)sender didPushAndReturnError:(NSError **)outError
If an error occurs, this method returns NO and sets outError to an NSError object that describes the error.
ISyncSessionDriver.hInforms the receiver that the client received a sync alert. (required)
- (BOOL)sessionDriver:(ISyncSessionDriver *)senderdidReceiveSyncAlertAndReturnError:(NSError **)outError
The object sending this message.
An error if it occurs.
NO if the client should not join; otherwise, YES.
Implement this method to perform any setup before the sync session driver syncs. You should implement this method if you register for a sync alert handler and want the sync to be completely asynchronous; otherwise, the thread which handles the sync alert may block until the sync session starts.
ISyncSessionDriver.hInforms the receiver that a client was registered. (required)
- (BOOL)sessionDriver:(ISyncSessionDriver *)sender didRegisterClientAndReturnError:(NSError **)outError
If an error occurs, this method returns NO and sets outError to an NSError object that describes the error.
ISyncSessionDriver.hInforms the receiver that a session will be finished. (required)
- (BOOL)sessionDriver:(ISyncSessionDriver *)sender willFinishSessionAndReturnError:(NSError **)outError
If an error occurs, this method returns NO and sets outError to an NSError object that describes the error.
ISyncSessionDriver.hInforms the receiver that the client will negotiate with the sync engine. (required)
- (BOOL)sessionDriver:(ISyncSessionDriver *)sender willNegotiateAndReturnError:(NSError **)outError
The object sending this message.
An error if it occurs.
NO if an error occurs and outError is set to an NSError object that describes the error; otherwise, YES.
ISyncSessionDriver.hInforms the receiver that changes will be pulled from the sync engine. (required)
- (BOOL)sessionDriver:(ISyncSessionDriver *)sender willPullAndReturnError:(NSError **)outError
If an error occurs, this method returns NO and sets outError to an NSError object that describes the error.
ISyncSessionDriver.hInforms the receiver that client changes will be pushed to the sync engine. (required)
- (BOOL)sessionDriver:(ISyncSessionDriver *)sender willPushAndReturnError:(NSError **)outError
If an error occurs, this method returns NO and sets outError to an NSError object that describes the error.
ISyncSessionDriver.hInforms the receiver that a session was cancelled. (required)
- (void)sessionDriverDidCancelSession:(ISyncSessionDriver *)sender
ISyncSessionDriver.hInforms the receiver that a session was finished. (required)
- (void)sessionDriverDidFinishSession:(ISyncSessionDriver *)sender
ISyncSessionDriver.hInforms the receiver that a session will be cancelled. (required)
- (void)sessionDriverWillCancelSession:(ISyncSessionDriver *)sender
ISyncSessionDriver.hLast updated: 2009-07-29
Mac OS X Reference Library Core Services Layer Sync Services ISyncSessionDriverDelegate Protocol Reference