TICDSListOfApplicationRegisteredClientsOperation Class Reference
| Inherits from | TICDSOperation : NSOperation |
| Declared in | TICDSListOfApplicationRegisteredClientsOperation.h |
Overview
The TICDSListOfApplicationRegisteredClientsOperation class describes a generic operation used by the TICoreDataSync framework to fetch a list of the client devices that are registered to synchronize with the application.
The operation carries out the following tasks:
- Fetch a list of UUID identifiers of all registered clients from the application’s
ClientDevicesdirectory. - Fetch the
deviceInfo.plistfile for each registered client. - Optionally fetch a list of document UUID identifiers and add a
registeredDocumentskey to each device dictionary, with the value being an array of document identifiers, indicating the documents that the client has registered to synchronize.
Operations are typically created automatically by the relevant sync manager.
%warning%
Warning: You must use one of the subclasses ofTICDSListOfApplicationRegisteredClientsOperation.
Tasks
Overridden Methods
-
– fetchArrayOfClientUUIDStringsFetch an array of UUID strings for each client registered to synchronize this application (the names of the directories inside the
ClientDevicesdirectory. -
– fetchDeviceInfoDictionaryForClientWithIdentifier:Fetch the
deviceInfo.plist, decrypting it if necessary, for the specified client. -
– fetchArrayOfDocumentUUIDStringsFetch an array of UUID strings for each document registered for this application.
-
– fetchArrayOfClientsRegisteredForDocumentWithIdentifier:Fetch an array of UUID strings for each client registered to synchronize with this document (the names of the directories inside the document’s
SyncChangesdirectory. -
– fetchedArrayOfClientUUIDStrings:Pass back the assembled
NSArrayofNSStringclient identifiers. -
– fetchedDeviceInfoDictionary:forClientWithIdentifier:Pass back the
NSDictionarybuilt from the contents of thedeviceInfo.plistfor the specified client. -
– fetchedArrayOfDocumentUUIDStrings:Pass back the assembled
NSArrayofNSStringdocument identifiers. -
– fetchedArrayOfClients:registeredForDocumentWithIdentifier:Pass back the assembled
NSArrayofNSStringclient identifiers for this document.
Properties
-
synchronizedClientIdentifiersAn array used to keep track of the client identifiers while the operation is executing.
property -
temporaryDeviceInfoDictionariesA mutable dictionary used to keep track of the
propertydeviceInfo.plistdictionaries for each client while the operation is executing. -
deviceInfoDictionariesThe final dictionary of
propertydeviceInfo.plistdictionaries for each client once the operation has finished. -
synchronizedDocumentIdentifiersAn array used to keep track of the document identifiers while the operation is executing.
property -
shouldIncludeRegisteredDocumentsA Boolean indicating whether the operation should check which documents are synchronized by each client.
property
Properties
deviceInfoDictionaries
The final dictionary of deviceInfo.plist dictionaries for each client once the operation has finished.
@property (strong) NSDictionary *deviceInfoDictionariesDeclared In
TICDSListOfApplicationRegisteredClientsOperation.hshouldIncludeRegisteredDocuments
A Boolean indicating whether the operation should check which documents are synchronized by each client.
@property (assign) BOOL shouldIncludeRegisteredDocumentsDeclared In
TICDSListOfApplicationRegisteredClientsOperation.hsynchronizedClientIdentifiers
An array used to keep track of the client identifiers while the operation is executing.
@property (nonatomic, strong) NSMutableArray *synchronizedClientIdentifiersDeclared In
TICDSListOfApplicationRegisteredClientsOperation.hsynchronizedDocumentIdentifiers
An array used to keep track of the document identifiers while the operation is executing.
@property (nonatomic, strong) NSMutableArray *synchronizedDocumentIdentifiersDeclared In
TICDSListOfApplicationRegisteredClientsOperation.htemporaryDeviceInfoDictionaries
A mutable dictionary used to keep track of the deviceInfo.plist dictionaries for each client while the operation is executing.
@property (nonatomic, strong) NSMutableDictionary *temporaryDeviceInfoDictionariesDeclared In
TICDSListOfApplicationRegisteredClientsOperation.hInstance Methods
fetchArrayOfClientUUIDStrings
Fetch an array of UUID strings for each client registered to synchronize this application (the names of the directories inside the ClientDevices directory.
- (void)fetchArrayOfClientUUIDStringsDiscussion
This method must call fetchedArrayOfClientUUIDStrings: when finished.
Declared In
TICDSListOfApplicationRegisteredClientsOperation.hfetchArrayOfClientsRegisteredForDocumentWithIdentifier:
Fetch an array of UUID strings for each client registered to synchronize with this document (the names of the directories inside the document’s SyncChanges directory.
- (void)fetchArrayOfClientsRegisteredForDocumentWithIdentifier:(NSString *)anIdentifierDiscussion
This method must call fetchedArrayOfClients:registeredForDocumentWithIdentifier: when finished.
Declared In
TICDSListOfApplicationRegisteredClientsOperation.hfetchArrayOfDocumentUUIDStrings
Fetch an array of UUID strings for each document registered for this application.
- (void)fetchArrayOfDocumentUUIDStringsDiscussion
This method must call fetchedArrayOfDocumentUUIDStrings: when finished.
Declared In
TICDSListOfApplicationRegisteredClientsOperation.hfetchDeviceInfoDictionaryForClientWithIdentifier:
Fetch the deviceInfo.plist, decrypting it if necessary, for the specified client.
- (void)fetchDeviceInfoDictionaryForClientWithIdentifier:(NSString *)anIdentifierParameters
- anIdentifier
The UUID synchronization identifier of the client.
Discussion
This method must call fetchedDeviceInfoDictionary:forClientWithIdentifier: when finished.
Declared In
TICDSListOfApplicationRegisteredClientsOperation.hfetchedArrayOfClientUUIDStrings:
Pass back the assembled NSArray of NSString client identifiers.
- (void)fetchedArrayOfClientUUIDStrings:(NSArray *)anArrayParameters
- anArray
The array of identifiers, or
nilif an error occurred.
Discussion
If an error occurred, call setError: first, then specify nil for anArray.
Declared In
TICDSListOfApplicationRegisteredClientsOperation.hfetchedArrayOfClients:registeredForDocumentWithIdentifier:
Pass back the assembled NSArray of NSString client identifiers for this document.
- (void)fetchedArrayOfClients:(NSArray *)anArray registeredForDocumentWithIdentifier:(NSString *)anIdentifierParameters
- anArray
The array of identifiers, or
nilif an error occurred.
- anIdentifier
The identifier of the document.
Discussion
If an error occurred, call setError: first, then specify nil for anArray.
Declared In
TICDSListOfApplicationRegisteredClientsOperation.hfetchedArrayOfDocumentUUIDStrings:
Pass back the assembled NSArray of NSString document identifiers.
- (void)fetchedArrayOfDocumentUUIDStrings:(NSArray *)anArrayParameters
- anArray
The array of identifiers, or
nilif an error occurred.
Discussion
If an error occurred, call setError: first, then specify nil for anArray.
Declared In
TICDSListOfApplicationRegisteredClientsOperation.hfetchedDeviceInfoDictionary:forClientWithIdentifier:
Pass back the NSDictionary built from the contents of the deviceInfo.plist for the specified client.
- (void)fetchedDeviceInfoDictionary:(NSDictionary *)aDictionary forClientWithIdentifier:(NSString *)anIdentifierParameters
- 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
TICDSListOfApplicationRegisteredClientsOperation.h