Tasks

Designated Initializer

• – initWithDelegate:

  Initialize a document registration operation using a delegate that supports the TICDSDocumentRegistrationOperationDelegate protocol.

Methods Overridden by Subclasses

• – checkWhetherRemoteDocumentDirectoryExists

  Check whether a remote directory exists for this document.

• – checkWhetherRemoteDocumentWasDeleted

  Check whether the document was previously deleted (i.e., whether an identifier.plist file exists in the DeletedDocuments directory.

• – createRemoteDocumentDirectoryStructure

  Create remote document directory structure.

• – saveRemoteDocumentInfoPlistFromDictionary:

  Save the dictionary to a documentInfo.plist file in this document’s directory.

• – saveIntegrityKey:

  Save a file with the integrity key as its name to this document’s IntegrityKey directory.

• – fetchListOfIdentifiersOfAllRegisteredClientsForThisApplication

  Fetch a list of all clients registered to synchronize with this application.

• – addDeviceInfoPlistToDocumentDeletedClientsForClientWithIdentifier:

  Copy the specified client’s deviceInfo.plist file into the DeletedClients directory for this document, but name the copied file using the client’s identifier (identifier.plist).

• – deleteDocumentInfoPlistFromDeletedDocumentsDirectory

  Delete the identifier.plist file for this document from the DeletedDocuments directory.

• – checkWhetherClientDirectoryExistsInRemoteDocumentSyncChangesDirectory

  Check whether a directory exists for this client inside the document’s SyncChanges directory.

• – fetchRemoteIntegrityKey

  Fetch the integrity key for this document.

• – checkWhetherClientWasDeletedFromRemoteDocument

  Check whether this client has previously been deleted from synchronizing with this document.

• – deleteClientIdentifierFileFromDeletedClientsDirectory

  Delete the client’s file from the document’s DeletedClients directory.

• – createClientDirectoriesInRemoteDocumentDirectories

  Create directories for this client inside the SyncChanges and SyncCommands directories for this client.

Callbacks

• – discoveredStatusOfRemoteDocumentDirectory:

  Indicate the status of the remote document directory.

• – discoveredDeletionStatusOfRemoteDocument:

  Indicate whether the document was previously deleted.

• – createdRemoteDocumentDirectoryStructureWithSuccess:

  Indicate whether the creation of the remote document directory structure was successful.

• – savedRemoteDocumentInfoPlistWithSuccess:

  Indicate whether the documentInfo.plist file was saved successfully.

• – savedIntegrityKeyWithSuccess:

  Indicate whether the integrity key file was saved successfully.

• – fetchedListOfIdentifiersOfAllRegisteredClientsForThisApplication:

  Pass back the assembled NSArray of client identifiers registered to synchronize with the application.

• – addedDeviceInfoPlistToDocumentDeletedClientsForClientWithIdentifier:withSuccess:

  Indicate whether the deviceInfo.plist file was copied as identifier.plist to the DeletedClients directory for this document.

• – deletedDocumentInfoPlistFromDeletedDocumentsDirectoryWithSuccess:

  Indicate whether the identifier.plist file for this document was removed from the DeletedDocuments directory.

• – discoveredStatusOfClientDirectoryInRemoteDocumentSyncChangesDirectory:

  Indicate the status of this client’s directory inside the remote document SyncChanges directory.

• – fetchedRemoteIntegrityKey:

  Pass back the remote integrity key for this document.

• – discoveredDeletionStatusOfClient:

  Indicate whether the client has been deleted from synchronizing with this document.

• – deletedClientIdentifierFileFromDeletedClientsDirectoryWithSuccess:

  Indicate whether the client’s file in the document’s RecentSyncs directory was deleted successfully.

• – createdClientDirectoriesInRemoteDocumentDirectoriesWithSuccess:

  Indicate whether the creation of the client directories was successful.

Properties

•   paused

  Used to indicate whether the operation is currently paused awaiting input from the operation delegate, or in turn the document sync manager delegate.

  property
•   documentWasDeleted

  Used to indicate whether the reason a document doesn’t exist is because it was deleted.

  property
•   shouldCreateDocumentFileStructure

  Used by the TICDSDocumentSyncManager to indicate whether to create the remote document file structure after finding out it doesn’t exist.

  property
•   clientHasPreviouslySynchronizedThisDocument

  Used to keep track of whether the document has previously been synchronized by this client.

  property
•   documentIdentifier

  The document identifier.

  property
•   documentDescription

  The document description (typically a filename).

  property
•   clientDescription

  The client description.

  property
•   documentUserInfo

  The user info.

  property
•   integrityKey

  The integrity key provided either by the client to check existing data matches integrity, or set during registration for new documents.

  property