TICDSApplicationSyncManagerDelegate Protocol Reference
| Conforms to | NSObject |
| Declared in | TICDSClassesAndProtocols.h |
Overview
The TICDSApplicationSyncManagerDelegate protocol defines the methods implemented by delegates of a TICDSApplicationSyncManager object.
Tasks
Registration
-
– applicationSyncManagerDidBeginRegistering:Informs the delegate that the application sync manager has started the application registration process.
-
– applicationSyncManagerDidPauseRegistrationToAskWhetherToUseEncryptionForFirstTimeRegistration:Informs the delegate that the application sync manager paused the application registration process to find out whether to use encryption for this application, because this is the first time this application has been registered.
required method -
– applicationSyncManagerDidPauseRegistrationToRequestPasswordForEncryptedApplicationSyncData:Informs the delegate that the application sync manager paused the application registration process because a password is needed to work with this application’s encrypted data.
required method -
– applicationSyncManagerDidContinueRegistering:Informs the delegate that the application sync manager has resumed the application registration process.
-
– applicationSyncManager:didFailToRegisterWithError:Informs the delegate that the application sync manager failed to register the application because of an error.
-
– applicationSyncManagerDidFinishRegistering:Informs the delegate that the application sync manager finished registering the application successfully.
-
– applicationSyncManagerShouldSupportProcessingInBackgroundState:Asks the delegate whether or not the application sync manager should support continued operation processing after the app has been sent to a background state. If this delegate method isn’t implemented the application sync manager defaults to YES and will process items in the background. Background processing currently only applies to sync operations running on iOS.
-
– applicationSyncManagerShouldUseCompressionForWholeStoreMoves:Asks the delegate whether or not the application sync manager should support compressing the whole store file when transferring it between the local and remote locations. If this delegate method isn’t implemented the application sync manager defaults to YES and will compress the whole store.
Listing Previously Synchronized Documents
-
– applicationSyncManagerDidBeginCheckingForPreviouslySynchronizedDocuments:Informs the delegate that the application sync manager has started to check for available documents that have previously been synchronized.
-
– applicationSyncManager:didFailToCheckForPreviouslySynchronizedDocumentsWithError:Informs the delegate that the application sync manager failed to check for available documents that have previously been synchronized.
-
– applicationSyncManagerDidFinishCheckingAndFoundNoPreviouslySynchronizedDocuments:Informs the delegate that the application sync manager didn’t find any available documents that have previously been synchronized.
-
– applicationSyncManager:didFinishCheckingAndFoundPreviouslySynchronizedDocuments:Informs the delegate that the application sync manager found one or more available documents that have previously been synchronized.
Downloading a Previously Synchronized Document
-
– applicationSyncManager:didBeginDownloadingDocumentWithIdentifier:Informs the delegate that the application sync manager has started to download a requested document that has previously been synchronized.
-
– applicationSyncManager:didFailToDownloadDocumentWithIdentifier:error:Informs the delegate that the application sync manager failed to download a requested document because of an error.
-
– applicationSyncManager:willReplaceWholeStoreFileForDocumentWithIdentifier:atURL:Informs the delegate that the application sync manager is about to replace an existing store file on disc with a newly-downloaded file.
-
– applicationSyncManager:preConfiguredDocumentSyncManagerForDownloadedDocumentWithIdentifier:atURL:Invoked to request the delegate to return a configured (though not yet registered) document sync manager for a downloaded document.
required method -
– applicationSyncManager:didFinishDownloadingDocumentWithIdentifier:atURL:Informs the delegate that the application sync manager finished downloading a requested document successfully.
-
– applicationSyncManager:whileDownloadingDocumentWithIdentifier:didReportProgress:Informs the delegate on the operation’s progress being made in the download operation.
Registered Client Information
-
– applicationSyncManagerDidBeginToFetchInformationForAllRegisteredDevices:Informs the delegate that the application sync manager has begun to fetch information on all registered devices from the remote.
-
– applicationSyncManager:didFailToFetchInformationForAllRegisteredDevicesWithError:Informs the delegate that the application sync manager failed to fetch information on clients registered to synchronize with the application.
-
– applicationSyncManager:didFinishFetchingInformationForAllRegisteredDevices:Informs the delegate that the application sync manager finished fetching information for all registered devices for this application.
Document Deletion
-
– applicationSyncManager:didBeginDeletionProcessForDocumentWithIdentifier:Informs the delegate that the application sync manager has begun the process of deleting a document from the remote.
-
– applicationSyncManager:didFailToDeleteDocumentWithIdentifier:error:Informs the delegate that the application sync manager failed to delete a document.
-
– applicationSyncManager:willDeleteDirectoryForDocumentWithIdentifier:Informs the delegate that the document’s directory is about to be removed from the remote.
-
– applicationSyncManager:didDeleteDirectoryForDocumentWithIdentifier:Informs the delegate that the document’s directory has just been removed from the remote.
-
– applicationSyncManager:didFinishDeletingDocumentWithIdentifier:Informs the delegate that the application sync manager completed the deletion process for the specified document.
Removing all Remote Sync Data
-
– applicationSyncManagerWillRemoveAllSyncData:Informs the delegate that the application sync manager will remove the entire remote directory structure.
-
– applicationSyncManagerDidFinishRemovingAllSyncData:Informs the delegate that the application sync manager has successfully removed the entire remote directory structure.
-
– applicationSyncManager:didFailToRemoveAllSyncDataWithError:Informs the delegate that the application sync manager failed to remove the entire remote directory structure.
Instance Methods
applicationSyncManager:didBeginDeletionProcessForDocumentWithIdentifier:
Informs the delegate that the application sync manager has begun the process of deleting a document from the remote.
- (void)applicationSyncManager:(TICDSApplicationSyncManager *)aSyncManager didBeginDeletionProcessForDocumentWithIdentifier:(NSString *)anIdentifierParameters
- aSyncManager
The application sync manager object that sent the message.
- anIdentifier
The identifier for the document that will be deleted.
Discussion
When the document directory is about to be deleted, the applicationSyncManager:willDeleteDirectoryForDocumentWithIdentifier: method will be called. Once the directory has been deleted, the applicationSyncManager:didDeleteDirectoryForDocumentWithIdentifier: method will be called.
At the end of the process, one of the applicationSyncManager:didFailToDeleteDocumentWithIdentifier:error: or applicationSyncManager:didFinishDeletingDocumentWithIdentifier: methods will be called.
Declared In
TICDSClassesAndProtocols.happlicationSyncManager:didBeginDownloadingDocumentWithIdentifier:
Informs the delegate that the application sync manager has started to download a requested document that has previously been synchronized.
- (void)applicationSyncManager:(TICDSApplicationSyncManager *)aSyncManager didBeginDownloadingDocumentWithIdentifier:(NSString *)anIdentifierParameters
- aSyncManager
The application sync manager object that sent the message.
- anIdentifier
The unique synchronization identifier of the document.
Declared In
TICDSClassesAndProtocols.happlicationSyncManager:didDeleteDirectoryForDocumentWithIdentifier:
Informs the delegate that the document’s directory has just been removed from the remote.
- (void)applicationSyncManager:(TICDSApplicationSyncManager *)aSyncManager didDeleteDirectoryForDocumentWithIdentifier:(NSString *)anIdentifierParameters
- aSyncManager
The application sync manager object that sent the message.
- anIdentifier
The identifier of the document that was deleted.
Declared In
TICDSClassesAndProtocols.happlicationSyncManager:didFailToCheckForPreviouslySynchronizedDocumentsWithError:
Informs the delegate that the application sync manager failed to check for available documents that have previously been synchronized.
- (void)applicationSyncManager:(TICDSApplicationSyncManager *)aSyncManager didFailToCheckForPreviouslySynchronizedDocumentsWithError:(NSError *)anErrorParameters
- aSyncManager
The application sync manager object that sent the message.
- anError
The error that caused the failure.
Declared In
TICDSClassesAndProtocols.happlicationSyncManager:didFailToDeleteDocumentWithIdentifier:error:
Informs the delegate that the application sync manager failed to delete a document.
- (void)applicationSyncManager:(TICDSApplicationSyncManager *)aSyncManager didFailToDeleteDocumentWithIdentifier:(NSString *)anIdentifier error:(NSError *)anErrorParameters
- aSyncManager
The application sync manager object that sent the message.
- anIdentifier
The identifier of the document that wasn’t deleted.
- anError
The error that caused the request process to fail.
Declared In
TICDSClassesAndProtocols.happlicationSyncManager:didFailToDownloadDocumentWithIdentifier:error:
Informs the delegate that the application sync manager failed to download a requested document because of an error.
- (void)applicationSyncManager:(TICDSApplicationSyncManager *)aSyncManager didFailToDownloadDocumentWithIdentifier:(NSString *)anIdentifier error:(NSError *)anErrorParameters
- aSyncManager
The application sync manager object that sent the message.
- anIdentifier
The unique synchronization identifier of the document.
- anError
The error that caused the download to fail.
Declared In
TICDSClassesAndProtocols.happlicationSyncManager:didFailToFetchInformationForAllRegisteredDevicesWithError:
Informs the delegate that the application sync manager failed to fetch information on clients registered to synchronize with the application.
- (void)applicationSyncManager:(TICDSApplicationSyncManager *)aSyncManager didFailToFetchInformationForAllRegisteredDevicesWithError:(NSError *)anErrorParameters
- aSyncManager
The application sync manager object that sent the message.
- anError
The error that caused the request process to fail.
Declared In
TICDSClassesAndProtocols.happlicationSyncManager:didFailToRegisterWithError:
Informs the delegate that the application sync manager failed to register the application because of an error.
- (void)applicationSyncManager:(TICDSApplicationSyncManager *)aSyncManager didFailToRegisterWithError:(NSError *)anErrorParameters
- aSyncManager
The application sync manager object that sent the message.
- anError
The error that caused the registration process to fail.
Declared In
TICDSClassesAndProtocols.happlicationSyncManager:didFailToRemoveAllSyncDataWithError:
Informs the delegate that the application sync manager failed to remove the entire remote directory structure.
- (void)applicationSyncManager:(TICDSApplicationSyncManager *)aSyncManager didFailToRemoveAllSyncDataWithError:(NSError *)anErrorParameters
- aSyncManager
The application sync manager object that sent the message.
- anError
The error that caused the deletion process to fail.
Declared In
TICDSClassesAndProtocols.happlicationSyncManager:didFinishCheckingAndFoundPreviouslySynchronizedDocuments:
Informs the delegate that the application sync manager found one or more available documents that have previously been synchronized.
- (void)applicationSyncManager:(TICDSApplicationSyncManager *)aSyncManager didFinishCheckingAndFoundPreviouslySynchronizedDocuments:(NSArray *)documentsArrayParameters
- aSyncManager
The application sync manager object that sent the message.
- documentsArray
An array of
NSDictionaryobjects containing information about each available document.
Discussion
One NSDictionary is supplied per document, containing the following keys:
kTICDSDocumentIdentifier–the unique synchronization identifier of the document.kTICDSDocumentDescription–the description of the document, as provided when it was originally registered.kTICDSOriginalDeviceIdentifier–the unique identifier of the client that first registered the document.kTICDSOriginalDeviceDescription–the description of the client that first registered the document.
Declared In
TICDSClassesAndProtocols.happlicationSyncManager:didFinishDeletingDocumentWithIdentifier:
Informs the delegate that the application sync manager completed the deletion process for the specified document.
- (void)applicationSyncManager:(TICDSApplicationSyncManager *)aSyncManager didFinishDeletingDocumentWithIdentifier:(NSString *)anIdentifierParameters
- aSyncManager
The application sync manager object that sent the message.
- anIdentifier
The identifier of the document that was deleted.
Declared In
TICDSClassesAndProtocols.happlicationSyncManager:didFinishDownloadingDocumentWithIdentifier:atURL:
Informs the delegate that the application sync manager finished downloading a requested document successfully.
- (void)applicationSyncManager:(TICDSApplicationSyncManager *)aSyncManager didFinishDownloadingDocumentWithIdentifier:(NSString *)anIdentifier atURL:(NSURL *)aFileURLParameters
- aSyncManager
The application sync manager object that sent the message.
- anIdentifier
The unique synchronization identifier of the document.
- aFileURL
The location of the downloaded store file.
Declared In
TICDSClassesAndProtocols.happlicationSyncManager:didFinishFetchingInformationForAllRegisteredDevices:
Informs the delegate that the application sync manager finished fetching information for all registered devices for this application.
- (void)applicationSyncManager:(TICDSApplicationSyncManager *)aSyncManager didFinishFetchingInformationForAllRegisteredDevices:(NSDictionary *)informationParameters
- aSyncManager
The application sync manager object that sent the message.
- information
A dictionary containing as keys the unique synchronization identifiers of each client, and as values dictionaries of information about that client.
Declared In
TICDSClassesAndProtocols.happlicationSyncManager:preConfiguredDocumentSyncManagerForDownloadedDocumentWithIdentifier:atURL:
Invoked to request the delegate to return a configured (though not yet registered) document sync manager for a downloaded document.
- (TICDSDocumentSyncManager *)applicationSyncManager:(TICDSApplicationSyncManager *)aSyncManager preConfiguredDocumentSyncManagerForDownloadedDocumentWithIdentifier:(NSString *)anIdentifier atURL:(NSURL *)aFileURLParameters
- aSyncManager
The document sync manager object that sent the message.
- anIdentifier
The unique synchronization identifier for the document.
- aFileURL
The location on disc of the downloaded document.
Return Value
The pre-configured, unregistered sync manager for the document.
Discussion
This method will be called once the whole store has been replaced for the document. You should create a suitable document sync manager for the downloaded store, and configure it by calling preConfigureWithDelegate:appSyncManager:documentIdentifier:;
%warning%
Warning: Do not register the document sync manager until after theapplicationSyncManager:didFinishDownloadingDocumentWithIdentifier:atURL:method is called.When you do register, you must use the full
registerWithDelegate:appSyncManager:managedObjectContext:documentIdentifier:description:userInfo:method, and not theregisterConfiguredDocumentSyncManagermethod. The latter is used for the delayed registration option; a pre-configured document sync manager is not the same as a configured document sync manager.
Declared In
TICDSClassesAndProtocols.happlicationSyncManager:whileDownloadingDocumentWithIdentifier:didReportProgress:
Informs the delegate on the operation’s progress being made in the download operation.
- (void)applicationSyncManager:(TICDSApplicationSyncManager *)aSyncManager whileDownloadingDocumentWithIdentifier:(NSString *)anIdentifier didReportProgress:(CGFloat)progressParameters
- aSyncManager
The application sync manager object that sent the message.
- anIdentifier
The unique synchronization identifier of the document.
- progress
The progress level (0 to 1) as reported by the operation.
Declared In
TICDSClassesAndProtocols.happlicationSyncManager:willDeleteDirectoryForDocumentWithIdentifier:
Informs the delegate that the document’s directory is about to be removed from the remote.
- (void)applicationSyncManager:(TICDSApplicationSyncManager *)aSyncManager willDeleteDirectoryForDocumentWithIdentifier:(NSString *)anIdentifierParameters
- aSyncManager
The application sync manager object that sent the message.
- anIdentifier
The identifier of the document that will be deleted.
Declared In
TICDSClassesAndProtocols.happlicationSyncManager:willReplaceWholeStoreFileForDocumentWithIdentifier:atURL:
Informs the delegate that the application sync manager is about to replace an existing store file on disc with a newly-downloaded file.
- (void)applicationSyncManager:(TICDSApplicationSyncManager *)aSyncManager willReplaceWholeStoreFileForDocumentWithIdentifier:(NSString *)anIdentifier atURL:(NSURL *)aFileURLParameters
- aSyncManager
The application sync manager object that sent the message.
- anIdentifier
The unique synchronization identifier of the document.
- aFileURL
The location on disc of the existing document that will be replaced.
Declared In
TICDSClassesAndProtocols.happlicationSyncManagerDidBeginCheckingForPreviouslySynchronizedDocuments:
Informs the delegate that the application sync manager has started to check for available documents that have previously been synchronized.
- (void)applicationSyncManagerDidBeginCheckingForPreviouslySynchronizedDocuments:(TICDSApplicationSyncManager *)aSyncManagerParameters
- aSyncManager
The application sync manager object that sent the message.
Discussion
At the end of the process, one of the applicationSyncManager:didFailToCheckForPreviouslySynchronizedDocumentsWithError:, applicationSyncManagerDidFinishCheckingAndFoundNoPreviouslySynchronizedDocuments:, or applicationSyncManager:didFinishCheckingAndFoundPreviouslySynchronizedDocuments: methods will be called.
Declared In
TICDSClassesAndProtocols.happlicationSyncManagerDidBeginRegistering:
Informs the delegate that the application sync manager has started the application registration process.
- (void)applicationSyncManagerDidBeginRegistering:(TICDSApplicationSyncManager *)aSyncManagerParameters
- aSyncManager
The application sync manager object that sent the message.
Discussion
At the end of the registration process, one of the applicationSyncManager:didFailToRegisterWithError: or applicationSyncManagerDidFinishRegistering: methods will be called.
Declared In
TICDSClassesAndProtocols.happlicationSyncManagerDidBeginToFetchInformationForAllRegisteredDevices:
Informs the delegate that the application sync manager has begun to fetch information on all registered devices from the remote.
- (void)applicationSyncManagerDidBeginToFetchInformationForAllRegisteredDevices:(TICDSApplicationSyncManager *)aSyncManagerParameters
- aSyncManager
The application sync manager object that sent the message.
Discussion
At the end of the request process, one of the applicationSyncManager:didFailToFetchInformationForAllRegisteredDevicesWithError: or applicationSyncManagerDidFinishFetchingInformationForAllRegisteredDevices: methods will be called.
Declared In
TICDSClassesAndProtocols.happlicationSyncManagerDidContinueRegistering:
Informs the delegate that the application sync manager has resumed the application registration process.
- (void)applicationSyncManagerDidContinueRegistering:(TICDSApplicationSyncManager *)aSyncManagerParameters
- aSyncManager
The application sync manager object that sent the message.
Declared In
TICDSClassesAndProtocols.happlicationSyncManagerDidFinishCheckingAndFoundNoPreviouslySynchronizedDocuments:
Informs the delegate that the application sync manager didn’t find any available documents that have previously been synchronized.
- (void)applicationSyncManagerDidFinishCheckingAndFoundNoPreviouslySynchronizedDocuments:(TICDSApplicationSyncManager *)aSyncManagerParameters
- aSyncManager
The application sync manager object that sent the message.
Declared In
TICDSClassesAndProtocols.happlicationSyncManagerDidFinishRegistering:
Informs the delegate that the application sync manager finished registering the application successfully.
- (void)applicationSyncManagerDidFinishRegistering:(TICDSApplicationSyncManager *)aSyncManagerParameters
- aSyncManager
The application sync manager object that sent the message.
Declared In
TICDSClassesAndProtocols.happlicationSyncManagerDidFinishRemovingAllSyncData:
Informs the delegate that the application sync manager has successfully removed the entire remote directory structure.
- (void)applicationSyncManagerDidFinishRemovingAllSyncData:(TICDSApplicationSyncManager *)aSyncManagerParameters
- aSyncManager
The application sync manager object that sent the message.
Declared In
TICDSClassesAndProtocols.happlicationSyncManagerDidPauseRegistrationToAskWhetherToUseEncryptionForFirstTimeRegistration:
Informs the delegate that the application sync manager paused the application registration process to find out whether to use encryption for this application, because this is the first time this application has been registered.
- (void)applicationSyncManagerDidPauseRegistrationToAskWhetherToUseEncryptionForFirstTimeRegistration:(TICDSApplicationSyncManager *)aSyncManagerParameters
- aSyncManager
The application sync manager object that sent the message.
Discussion
%warning%
Warning: You must call thecontinueRegisteringWithEncryptionPassword:method to indicate whether registration should use an encryption password, or stay unencrypted, otherwise the registration process will be left permanently suspended.
Declared In
TICDSClassesAndProtocols.happlicationSyncManagerDidPauseRegistrationToRequestPasswordForEncryptedApplicationSyncData:
Informs the delegate that the application sync manager paused the application registration process because a password is needed to work with this application’s encrypted data.
- (void)applicationSyncManagerDidPauseRegistrationToRequestPasswordForEncryptedApplicationSyncData:(TICDSApplicationSyncManager *)aSyncManagerParameters
- aSyncManager
The application sync manager object that sent the message.
Discussion
%warning%
Warning: You must call thecontinueRegisteringWithEncryptionPassword:method to indicate the password to use, or the registration process will be left permanently suspended.
Declared In
TICDSClassesAndProtocols.happlicationSyncManagerShouldSupportProcessingInBackgroundState:
Asks the delegate whether or not the application sync manager should support continued operation processing after the app has been sent to a background state. If this delegate method isn’t implemented the application sync manager defaults to YES and will process items in the background. Background processing currently only applies to sync operations running on iOS.
- (BOOL)applicationSyncManagerShouldSupportProcessingInBackgroundState:(TICDSApplicationSyncManager *)aSyncManagerParameters
- aSyncManager
The application sync manager object that sent the message.
Declared In
TICDSClassesAndProtocols.happlicationSyncManagerShouldUseCompressionForWholeStoreMoves:
Asks the delegate whether or not the application sync manager should support compressing the whole store file when transferring it between the local and remote locations. If this delegate method isn’t implemented the application sync manager defaults to YES and will compress the whole store.
- (BOOL)applicationSyncManagerShouldUseCompressionForWholeStoreMoves:(TICDSApplicationSyncManager *)aSyncManagerParameters
- aSyncManager
The application sync manager object that sent the message.
Declared In
TICDSClassesAndProtocols.happlicationSyncManagerWillRemoveAllSyncData:
Informs the delegate that the application sync manager will remove the entire remote directory structure.
- (void)applicationSyncManagerWillRemoveAllSyncData:(TICDSApplicationSyncManager *)aSyncManagerParameters
- aSyncManager
The application sync manager object that sent the message.
Declared In
TICDSClassesAndProtocols.h