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:

  1. Fetch a list of UUID identifiers of all registered clients from the application’s ClientDevices directory.
  2. Fetch the deviceInfo.plist file for each registered client.
  3. Optionally fetch a list of document UUID identifiers and add a registeredDocuments key 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 of TICDSListOfApplicationRegisteredClientsOperation.

Tasks

Overridden Methods

Properties

Properties

deviceInfoDictionaries

The final dictionary of deviceInfo.plist dictionaries for each client once the operation has finished.

@property (strong) NSDictionary *deviceInfoDictionaries

Declared In

TICDSListOfApplicationRegisteredClientsOperation.h

shouldIncludeRegisteredDocuments

A Boolean indicating whether the operation should check which documents are synchronized by each client.

@property (assign) BOOL shouldIncludeRegisteredDocuments

Declared In

TICDSListOfApplicationRegisteredClientsOperation.h

synchronizedClientIdentifiers

An array used to keep track of the client identifiers while the operation is executing.

@property (nonatomic, strong) NSMutableArray *synchronizedClientIdentifiers

Declared In

TICDSListOfApplicationRegisteredClientsOperation.h

synchronizedDocumentIdentifiers

An array used to keep track of the document identifiers while the operation is executing.

@property (nonatomic, strong) NSMutableArray *synchronizedDocumentIdentifiers

Declared In

TICDSListOfApplicationRegisteredClientsOperation.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

TICDSListOfApplicationRegisteredClientsOperation.h

Instance 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)fetchArrayOfClientUUIDStrings

Discussion

This method must call fetchedArrayOfClientUUIDStrings: when finished.

Declared In

TICDSListOfApplicationRegisteredClientsOperation.h

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 SyncChanges directory.

- (void)fetchArrayOfClientsRegisteredForDocumentWithIdentifier:(NSString *)anIdentifier

Discussion

This method must call fetchedArrayOfClients:registeredForDocumentWithIdentifier: when finished.

Declared In

TICDSListOfApplicationRegisteredClientsOperation.h

fetchArrayOfDocumentUUIDStrings

Fetch an array of UUID strings for each document registered for this application.

- (void)fetchArrayOfDocumentUUIDStrings

Discussion

This method must call fetchedArrayOfDocumentUUIDStrings: when finished.

Declared In

TICDSListOfApplicationRegisteredClientsOperation.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

TICDSListOfApplicationRegisteredClientsOperation.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

TICDSListOfApplicationRegisteredClientsOperation.h

fetchedArrayOfClients:registeredForDocumentWithIdentifier:

Pass back the assembled NSArray of NSString client identifiers for this document.

- (void)fetchedArrayOfClients:(NSArray *)anArray registeredForDocumentWithIdentifier:(NSString *)anIdentifier

Parameters

anArray

The array of identifiers, or nil if 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.h

fetchedArrayOfDocumentUUIDStrings:

Pass back the assembled NSArray of NSString document identifiers.

- (void)fetchedArrayOfDocumentUUIDStrings:(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

TICDSListOfApplicationRegisteredClientsOperation.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

TICDSListOfApplicationRegisteredClientsOperation.h