TICDSWholeStoreDownloadOperation Class Reference
| Inherits from | TICDSOperation : NSOperation |
| Declared in | TICDSWholeStoreDownloadOperation.h |
Overview
The TICDSWholeStoreDownloadOperation class describes a generic operation used by the TICoreDataSync framework to download the whole store for a document.
The operation carries out the following tasks:
- If
requestedWholeStoreClientIdentifieris not set, determine which client uploaded a store most recently, and setrequestedWholeStoreClientIdentifier. - Download the whole store file from the
requestedWholeStoreClientIdentifier’s directory. - Download the applied sync change sets file that goes with this whole store.
Operations are typically created automatically by the relevant sync manager.
%warning%
Warning: You must use one of the subclasses ofTICDSWholeStoreDownloadOperation.
Tasks
Methods Overridden by Subclasses
-
– checkForMostRecentClientWholeStoreDetermine which client uploaded a WholeStore most recently.
-
– downloadWholeStoreFileDownload the store at the remote document store path to the
localWholeStoreFileLocation. -
– downloadAppliedSyncChangeSetsFileDownload the applied sync change sets file at the remote document store path to the
localAppliedSyncChangeSetsFileLocation. -
– fetchRemoteIntegrityKeyFetch the integrity key for this document.
Callbacks
-
– determinedMostRecentWholeStoreWasUploadedByClientWithIdentifier:Indicate which client uploaded the most recent WholeStore.
-
– downloadingWholeStoreFileMadeProgressIndicate when the download operation makes progress.
-
– downloadedWholeStoreFileWithSuccess:Indicate whether the download of the whole store file was successful.
-
– downloadingAppliedSyncChangeSetsFileMadeProgressIndicate when the download operation makes progress.
-
– downloadedAppliedSyncChangeSetsFileWithSuccess:Indicate whether the download of the applied sync change sets file was successful.
-
– fetchedRemoteIntegrityKey:Pass back the remote integrity key for this document.
Properties
-
requestedWholeStoreClientIdentifierThe client identifier for the WholeStore to download. If this is not specified before the operation executes, the operation will determine which client uploaded a store most recently.
property -
localWholeStoreFileLocationThe destination for the whole store file.
property -
localAppliedSyncChangeSetsFileLocationThe destination for the applied sync change sets file.
property -
integrityKeyThe integrity key of the newly-downloaded store.
property
Properties
integrityKey
The integrity key of the newly-downloaded store.
@property (copy) NSString *integrityKeyDeclared In
TICDSWholeStoreDownloadOperation.hlocalAppliedSyncChangeSetsFileLocation
The destination for the applied sync change sets file.
@property (strong) NSURL *localAppliedSyncChangeSetsFileLocationDeclared In
TICDSWholeStoreDownloadOperation.hlocalWholeStoreFileLocation
The destination for the whole store file.
@property (strong) NSURL *localWholeStoreFileLocationDeclared In
TICDSWholeStoreDownloadOperation.hrequestedWholeStoreClientIdentifier
The client identifier for the WholeStore to download. If this is not specified before the operation executes, the operation will determine which client uploaded a store most recently.
@property (copy) NSString *requestedWholeStoreClientIdentifierDeclared In
TICDSWholeStoreDownloadOperation.hInstance Methods
checkForMostRecentClientWholeStore
Determine which client uploaded a WholeStore most recently.
- (void)checkForMostRecentClientWholeStoreDiscussion
This method must call determinedMostRecentWholeStoreWasUploadedByClientWithIdentifier: when finished.
Declared In
TICDSWholeStoreDownloadOperation.hdeterminedMostRecentWholeStoreWasUploadedByClientWithIdentifier:
Indicate which client uploaded the most recent WholeStore.
- (void)determinedMostRecentWholeStoreWasUploadedByClientWithIdentifier:(NSString *)anIdentifierParameters
- anIdentifier
The identifier of the client.
Discussion
If an error occurs, call setError: first, then specify nil for anIdentifier
Declared In
TICDSWholeStoreDownloadOperation.hdownloadAppliedSyncChangeSetsFile
Download the applied sync change sets file at the remote document store path to the localAppliedSyncChangeSetsFileLocation.
- (void)downloadAppliedSyncChangeSetsFileDiscussion
This method must call downloadedAppliedSyncChangeSetsFileWithSuccess: when finished.
Declared In
TICDSWholeStoreDownloadOperation.hdownloadWholeStoreFile
Download the store at the remote document store path to the localWholeStoreFileLocation.
- (void)downloadWholeStoreFileDiscussion
This method must call downloadedWholeStoreFileWithSuccess: when finished.
Declared In
TICDSWholeStoreDownloadOperation.hdownloadedAppliedSyncChangeSetsFileWithSuccess:
Indicate whether the download of the applied sync change sets file was successful.
- (void)downloadedAppliedSyncChangeSetsFileWithSuccess:(BOOL)successParameters
- success
YESif the applied sync change sets file was downloaded, otherwiseNO.
Discussion
If not, call setError: first, then specify NO for success.
Declared In
TICDSWholeStoreDownloadOperation.hdownloadedWholeStoreFileWithSuccess:
Indicate whether the download of the whole store file was successful.
- (void)downloadedWholeStoreFileWithSuccess:(BOOL)successParameters
- success
YESif the whole store file was downloaded, otherwiseNO.
Discussion
If not, call setError: first, then specify NO for success.
Declared In
TICDSWholeStoreDownloadOperation.hdownloadingAppliedSyncChangeSetsFileMadeProgress
Indicate when the download operation makes progress.
- (void)downloadingAppliedSyncChangeSetsFileMadeProgressDeclared In
TICDSWholeStoreDownloadOperation.hdownloadingWholeStoreFileMadeProgress
Indicate when the download operation makes progress.
- (void)downloadingWholeStoreFileMadeProgressDeclared In
TICDSWholeStoreDownloadOperation.hfetchRemoteIntegrityKey
Fetch the integrity key for this document.
- (void)fetchRemoteIntegrityKeyDiscussion
This method must call fetchedRemoteIntegrityKey: to provide the key.
Declared In
TICDSWholeStoreDownloadOperation.hfetchedRemoteIntegrityKey:
Pass back the remote integrity key for this document.
- (void)fetchedRemoteIntegrityKey:(NSString *)aKeyParameters
- aKey
The remote integrity key, or
nilif an error occurred.
Discussion
If an error occurred, call setError: first, then specify nil for aKey.
Declared In
TICDSWholeStoreDownloadOperation.h