TICDSListOfDocumentRegisteredClientsOperation Class Reference
Inherits from | TICDSOperation : NSOperation |
Declared in | TICDSListOfDocumentRegisteredClientsOperation.h |
Overview
The TICDSListOfDocumentRegisteredClientsOperation
class describes a generic operation used by the TICoreDataSync
framework to fetch a list of the client devices that are registered to synchronize a given document.
The operation carries out the following tasks:
- Fetch a list of UUID identifiers of client directories inside the document’s
SyncChanges
directory. - Fetch the
deviceInfo.plist
file for each registered client. - Fetch the last modified date of each client’s
RecentSync
file, if it exists. - Fetch the last modified date of each client’s
WholeStore
upload, if it exists.
Operations are typically created automatically by the relevant sync manager.
%warning%
Warning: You must use one of the subclasses ofTICDSListOfDocumentRegisteredClientsOperation
.
Tasks
Overridden Methods
-
– fetchArrayOfClientUUIDStrings
Fetch an array of UUID strings for each client registered to synchronize this document (the names of the directories inside the document’s
SyncChanges
directory. -
– fetchDeviceInfoDictionaryForClientWithIdentifier:
Fetch the
deviceInfo.plist
, decrypting it if necessary, for the specified client. -
– fetchLastSynchronizationDates
Fetch the last modified dates of each client’s
RecentSync
file. -
– fetchModificationDateOfWholeStoreForClientWithIdentifier:
Fetch the last modified dates for the specified client’s
WholeStore
file. -
– fetchedArrayOfClientUUIDStrings:
Pass back the assembled
NSArray
ofNSString
client identifiers. -
– fetchedDeviceInfoDictionary:forClientWithIdentifier:
Pass back the
NSDictionary
built from the contents of thedeviceInfo.plist
for the specified client. -
– fetchedLastSynchronizationDate:forClientWithIdentifier:
Pass back the last modified date of the specified client’s
RecentSync
file. -
– fetchedModificationDate:ofWholeStoreForClientWithIdentifier:
Pass back the last modified date of the specified client’s WholeStore file.
Properties
-
synchronizedClientIdentifiers
An array used to keep track of the client identifiers while the operation is executing.
property -
temporaryDeviceInfoDictionaries
A mutable dictionary used to keep track of the
propertydeviceInfo.plist
dictionaries for each client while the operation is executing. -
deviceInfoDictionaries
The final dictionary of
propertydeviceInfo.plist
dictionaries for each client once the operation has finished.
Properties
deviceInfoDictionaries
The final dictionary of deviceInfo.plist
dictionaries for each client once the operation has finished.
@property (strong) NSDictionary *deviceInfoDictionaries
Declared In
TICDSListOfDocumentRegisteredClientsOperation.h
synchronizedClientIdentifiers
An array used to keep track of the client identifiers while the operation is executing.
@property (nonatomic, strong) NSArray *synchronizedClientIdentifiers
Declared In
TICDSListOfDocumentRegisteredClientsOperation.h
temporaryDeviceInfoDictionaries
A mutable dictionary used to keep track of the deviceInfo.plist
dictionaries for each client while the operation is executing.
@property (nonatomic, strong) NSMutableDictionary *temporaryDeviceInfoDictionaries
Declared In
TICDSListOfDocumentRegisteredClientsOperation.h
Instance Methods
fetchArrayOfClientUUIDStrings
Fetch an array of UUID strings for each client registered to synchronize this document (the names of the directories inside the document’s SyncChanges
directory.
- (void)fetchArrayOfClientUUIDStrings
Discussion
This method must call fetchedArrayOfClientUUIDStrings:
when finished.
Declared In
TICDSListOfDocumentRegisteredClientsOperation.h
fetchDeviceInfoDictionaryForClientWithIdentifier:
Fetch the deviceInfo.plist
, decrypting it if necessary, for the specified client.
- (void)fetchDeviceInfoDictionaryForClientWithIdentifier:(NSString *)anIdentifier
Parameters
- anIdentifier
The UUID synchronization identifier of the client.
Discussion
This method must call fetchedDeviceInfoDictionary:forClientWithIdentifier:
when finished.
Declared In
TICDSListOfDocumentRegisteredClientsOperation.h
fetchLastSynchronizationDates
Fetch the last modified dates of each client’s RecentSync
file.
- (void)fetchLastSynchronizationDates
Discussion
This method must call fetchedLastSynchronizationDate:forClientWithIdentifier:
once per client in synchronizedClientIdentifiers
to provide the information.
Declared In
TICDSListOfDocumentRegisteredClientsOperation.h
fetchModificationDateOfWholeStoreForClientWithIdentifier:
Fetch the last modified dates for the specified client’s WholeStore
file.
- (void)fetchModificationDateOfWholeStoreForClientWithIdentifier:(NSString *)anIdentifier
Parameters
- anIdentifier
The UUID synchronization identifier of the client.
Discussion
This method must call fetchedModificationDate:ofWholeStoreForClientWithIdentifier:
when finished.
Declared In
TICDSListOfDocumentRegisteredClientsOperation.h
fetchedArrayOfClientUUIDStrings:
Pass back the assembled NSArray
of NSString
client identifiers.
- (void)fetchedArrayOfClientUUIDStrings:(NSArray *)anArray
Parameters
- anArray
The array of identifiers, or
nil
if an error occurred.
Discussion
If an error occurred, call setError:
first, then specify nil
for anArray
.
Declared In
TICDSListOfDocumentRegisteredClientsOperation.h
fetchedDeviceInfoDictionary:forClientWithIdentifier:
Pass back the NSDictionary
built from the contents of the deviceInfo.plist
for the specified client.
- (void)fetchedDeviceInfoDictionary:(NSDictionary *)aDictionary forClientWithIdentifier:(NSString *)anIdentifier
Parameters
- aDictionary
The assembled dictionary of device information.
- anIdentifier
The UUID synchronization identifier of the client.
Discussion
If an error occurred, call setError:
first, then specify nil
for aDictionary
.
Declared In
TICDSListOfDocumentRegisteredClientsOperation.h
fetchedLastSynchronizationDate:forClientWithIdentifier:
Pass back the last modified date of the specified client’s RecentSync
file.
- (void)fetchedLastSynchronizationDate:(NSDate *)aDate forClientWithIdentifier:(NSString *)anIdentifier
Parameters
- aDate
The last modified date of the
RecentSync
file.
- anIdentifier
The UUID synchronization identifier of the client.
Discussion
If an error occurred, call setError:
first, then specify nil
for aDate
.
Declared In
TICDSListOfDocumentRegisteredClientsOperation.h
fetchedModificationDate:ofWholeStoreForClientWithIdentifier:
Pass back the last modified date of the specified client’s WholeStore file.
- (void)fetchedModificationDate:(NSDate *)aDate ofWholeStoreForClientWithIdentifier:(NSString *)anIdentifier
Parameters
- aDate
The last modified date of the client’s
WholeStore
file.
- anIdentifier
The UUID synchronization identifier of the client.
Discussion
If an error occurred, call setError:
first, then specify nil
for aDate
.
Declared In
TICDSListOfDocumentRegisteredClientsOperation.h