TICDSDocumentClientDeletionOperation Class Reference

Inherits from	TICDSOperation : NSOperation
Declared in	TICDSDocumentClientDeletionOperation.h

Overview

The TICDSDocumentClientDeletionOperation class describes a generic operation used by the TICoreDataSync framework to delete the remote synchronization data used by a client to synchronize a document.

The operation carries out the following tasks:

Check whether the specified client has synchronized the document.
Copy the deviceInfo.plist file to an identifier.plist file inside the document’s DeletedClients directory.
Delete the client’s SyncChanges, SyncCommands and WholeStore directories for the document.

Operations are typically created automatically by the relevant sync manager.

You must use one of the subclasses of TICDSDocumentDeletionOperation.

Tasks

Overridden Methods

– checkWhetherClientDirectoryExistsInDocumentSyncChangesDirectory
Check whether a directory exists for the client inside the document’s SyncChanges directory.
– checkWhetherClientIdentifierFileAlreadyExistsInDocumentDeletedClientsDirectory
Check whether an identifier.plist file already exists for the client in the document’s DeletedClients directory.
– deleteClientIdentifierFileFromDeletedClientsDirectory
Delete the client’s identifier.plist file from the document’s DeletedClients directory.
– copyClientDeviceInfoPlistToDeletedClientsDirectory
Copy the client’s deviceInfo.plist file to an identifier.plist file in the document’s DeletedClients directory.
– deleteClientDirectoryFromDocumentSyncChangesDirectory
Delete the client’s directory from the document’s SyncChanges directory.
– deleteClientDirectoryFromDocumentSyncCommandsDirectory
Delete the client’s directory from the document’s SyncCommands directory.
– checkWhetherClientIdentifierFileExistsInRecentSyncsDirectory
Checks whether a file exists for the client in the document’s RecentSyncs directory.
– deleteClientIdentifierFileFromRecentSyncsDirectory
Delete the client’s file from the document’s RecentSyncs directory.
– checkWhetherClientDirectoryExistsInDocumentWholeStoreDirectory
Check whether a directory exists for the client in the document’s WholeStore directory.
– deleteClientDirectoryFromDocumentWholeStoreDirectory
Delete the client’s directory from the document’s WholeStore directory.

Callbacks

– discoveredStatusOfClientDirectoryInDocumentSyncChangesDirectory:
Indicate the status of the client’s directory inside the document’s SyncChanges directory.
– discoveredStatusOfClientIdentifierFileInDocumentDeletedClientsDirectory:
Indicate the status of the client’s identifier.plist inside the document’s DeletedClients directory.
– deletedClientIdentifierFileFromDeletedClientsDirectoryWithSuccess:
Indicate whether the identifier.plist file was deleted successfully from the document’s DeletedClients directory.
– copiedClientDeviceInfoPlistToDeletedClientsDirectoryWithSuccess:
Indicate whether the client’s deviceInfo.plist file was copied to an identifier.plist file in the document’s DeletedClients directory.
– deletedClientDirectoryFromDocumentSyncChangesDirectoryWithSuccess:
Indicate whether the client’s directory was deleted successfully from the document’s SyncChanges directory.
– deletedClientDirectoryFromDocumentSyncCommandsDirectoryWithSuccess:
Indicate whether the client’s directory was deleted successfully from the document’s SyncCommands directory.
– discoveredStatusOfClientIdentifierFileInDocumentRecentSyncsDirectory:
Indicate the status of the client’s file inside the document’s RecentSyncs directory.
– deletedClientIdentifierFileFromRecentSyncsDirectoryWithSuccess:
Indicate whether the client’s file was deleted successfully from the document’s RecentSyncs directory.
– discoveredStatusOfClientDirectoryInDocumentWholeStoreDirectory:
Indicate the status of the client’s directory inside the document’s WholeStore directory.
– deletedClientDirectoryFromDocumentWholeStoreDirectoryWithSuccess:
Indicate whether the client’s directory was deleted successfully from the document’s WholeStore directory.

Properties

identifierOfClientToBeDeleted
The identifier of the client to be deleted.
property
clientWasFoundAndDeleted
Used to indicate (once the operation completes) whether the client was found and deleted successfully.
property

Properties

clientWasFoundAndDeleted

Used to indicate (once the operation completes) whether the client was found and deleted successfully.

@property (assign) BOOL clientWasFoundAndDeleted

Declared In

TICDSDocumentClientDeletionOperation.h

identifierOfClientToBeDeleted

The identifier of the client to be deleted.

@property (retain) NSString *identifierOfClientToBeDeleted

Declared In

TICDSDocumentClientDeletionOperation.h

Instance Methods

checkWhetherClientDirectoryExistsInDocumentSyncChangesDirectory

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

- (void)checkWhetherClientDirectoryExistsInDocumentSyncChangesDirectory

Discussion

This method must call discoveredStatusOfClientDirectoryInDocumentSyncChangesDirectory: to indicate the status.

Declared In

TICDSDocumentClientDeletionOperation.h

checkWhetherClientDirectoryExistsInDocumentWholeStoreDirectory

Check whether a directory exists for the client in the document’s WholeStore directory.

- (void)checkWhetherClientDirectoryExistsInDocumentWholeStoreDirectory

Discussion

This method must call discoveredStatusOfClientDirectoryInDocumentWholeStoreDirectory: to indicate the status.

Declared In

TICDSDocumentClientDeletionOperation.h

checkWhetherClientIdentifierFileAlreadyExistsInDocumentDeletedClientsDirectory

Check whether an identifier.plist file already exists for the client in the document’s DeletedClients directory.

- (void)checkWhetherClientIdentifierFileAlreadyExistsInDocumentDeletedClientsDirectory

Discussion

This method must call discoveredStatusOfClientIdentifierFileInDocumentDeletedClientsDirectory: to indicate the status.

Declared In

TICDSDocumentClientDeletionOperation.h

checkWhetherClientIdentifierFileExistsInRecentSyncsDirectory

Checks whether a file exists for the client in the document’s RecentSyncs directory.

- (void)checkWhetherClientIdentifierFileExistsInRecentSyncsDirectory

Discussion

This method must call discoveredStatusOfClientIdentifierFileInDocumentRecentSyncsDirectory: when finished.

Declared In

TICDSDocumentClientDeletionOperation.h

copiedClientDeviceInfoPlistToDeletedClientsDirectoryWithSuccess:

Indicate whether the client’s deviceInfo.plist file was copied to an identifier.plist file in the document’s DeletedClients directory.

- (void)copiedClientDeviceInfoPlistToDeletedClientsDirectoryWithSuccess:(BOOL)success

Parameters

success: YES if the file was copied successfully, or NO if an error occurred.

Discussion

If an error occurred, call setError: first, then specify NO for success.

Declared In

TICDSDocumentClientDeletionOperation.h

copyClientDeviceInfoPlistToDeletedClientsDirectory

Copy the client’s deviceInfo.plist file to an identifier.plist file in the document’s DeletedClients directory.

- (void)copyClientDeviceInfoPlistToDeletedClientsDirectory

Discussion

This method must call copiedClientDeviceInfoPlistToDeletedClientsDirectoryWithSuccess: when finished.

Declared In

TICDSDocumentClientDeletionOperation.h

deleteClientDirectoryFromDocumentSyncChangesDirectory

Delete the client’s directory from the document’s SyncChanges directory.

- (void)deleteClientDirectoryFromDocumentSyncChangesDirectory

Discussion

This method must call deletedClientDirectoryFromDocumentSyncChangesDirectoryWithSuccess: when finished.

Declared In

TICDSDocumentClientDeletionOperation.h

deleteClientDirectoryFromDocumentSyncCommandsDirectory

Delete the client’s directory from the document’s SyncCommands directory.

- (void)deleteClientDirectoryFromDocumentSyncCommandsDirectory

Discussion

This method must call deletedClientDirectoryFromDocumentSyncCommandsDirectoryWithSuccess: when finished.

Declared In

TICDSDocumentClientDeletionOperation.h

deleteClientDirectoryFromDocumentWholeStoreDirectory

Delete the client’s directory from the document’s WholeStore directory.

- (void)deleteClientDirectoryFromDocumentWholeStoreDirectory

Discussion

This method must call deletedClientDirectoryFromDocumentWholeStoreDirectoryWithSuccess: when finished.

Declared In

TICDSDocumentClientDeletionOperation.h

deleteClientIdentifierFileFromDeletedClientsDirectory

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

- (void)deleteClientIdentifierFileFromDeletedClientsDirectory

Discussion

This method must call deletedClientIdentifierFileFromDeletedClientsDirectoryWithSuccess: to indicate the status.

Declared In

TICDSDocumentClientDeletionOperation.h

deleteClientIdentifierFileFromRecentSyncsDirectory

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

- (void)deleteClientIdentifierFileFromRecentSyncsDirectory

Discussion

This method must call blah: when finished.

Declared In

TICDSDocumentClientDeletionOperation.h

deletedClientDirectoryFromDocumentSyncChangesDirectoryWithSuccess:

Indicate whether the client’s directory was deleted successfully from the document’s SyncChanges directory.

- (void)deletedClientDirectoryFromDocumentSyncChangesDirectoryWithSuccess:(BOOL)success

Parameters

success: YES if the directory was deleted successfully, or NO if an error occurred.

Discussion

If an error occurred, call setError: first, then specify NO for success.

Declared In

TICDSDocumentClientDeletionOperation.h

deletedClientDirectoryFromDocumentSyncCommandsDirectoryWithSuccess:

Indicate whether the client’s directory was deleted successfully from the document’s SyncCommands directory.

- (void)deletedClientDirectoryFromDocumentSyncCommandsDirectoryWithSuccess:(BOOL)success

Parameters

success: YES if the directory was deleted successfully, or NO if an error occurred.

Discussion

If an error occurred, call setError: first, then specify NO for success.

Declared In

TICDSDocumentClientDeletionOperation.h

deletedClientDirectoryFromDocumentWholeStoreDirectoryWithSuccess:

Indicate whether the client’s directory was deleted successfully from the document’s WholeStore directory.

- (void)deletedClientDirectoryFromDocumentWholeStoreDirectoryWithSuccess:(BOOL)success

Parameters

success: YES if the directory was deleted successfully, or NO if an error occurred.

Discussion

If an error occurred, call setError: first, then specify NO for success.

Declared In

TICDSDocumentClientDeletionOperation.h

deletedClientIdentifierFileFromDeletedClientsDirectoryWithSuccess:

Indicate whether the identifier.plist file was deleted successfully from the document’s DeletedClients directory.

- (void)deletedClientIdentifierFileFromDeletedClientsDirectoryWithSuccess:(BOOL)success

Parameters

success: YES if the file was deleted successfully, or NO if an error occurred.

Discussion

If an error occurred, call setError: first, then specify NO for success.

Declared In

TICDSDocumentClientDeletionOperation.h

deletedClientIdentifierFileFromRecentSyncsDirectoryWithSuccess:

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

- (void)deletedClientIdentifierFileFromRecentSyncsDirectoryWithSuccess:(BOOL)success

Parameters

success: YES if the directory was deleted successfully, or NO if an error occurred.

Discussion

If an error occurred, call setError: first, then specify NO for success.

Declared In

TICDSDocumentClientDeletionOperation.h

discoveredStatusOfClientDirectoryInDocumentSyncChangesDirectory:

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

- (void)discoveredStatusOfClientDirectoryInDocumentSyncChangesDirectory:(TICDSRemoteFileStructureExistsResponseType)status

Parameters

status: The status of the directory: does exist, does not exist, or error (see TICDSTypesAndEnums.h for possible values).

Discussion

If an error occurred, call setError: first, then specify TICDSRemoteFileStructureExistsResponseTypeError for status.

Declared In

TICDSDocumentClientDeletionOperation.h

discoveredStatusOfClientDirectoryInDocumentWholeStoreDirectory:

Indicate the status of the client’s directory inside the document’s WholeStore directory.

- (void)discoveredStatusOfClientDirectoryInDocumentWholeStoreDirectory:(TICDSRemoteFileStructureExistsResponseType)status

Parameters

status: The status of the directory: does exist, does not exist, or error (see TICDSTypesAndEnums.h for possible values).

Discussion

If an error occurred, call setError: first, then specify TICDSRemoteFileStructureExistsResponseTypeError for status.

Declared In

TICDSDocumentClientDeletionOperation.h

discoveredStatusOfClientIdentifierFileInDocumentDeletedClientsDirectory:

Indicate the status of the client’s identifier.plist inside the document’s DeletedClients directory.

- (void)discoveredStatusOfClientIdentifierFileInDocumentDeletedClientsDirectory:(TICDSRemoteFileStructureExistsResponseType)status

Parameters

status: The status of the file: does exist, does not exist, or error (see TICDSTypesAndEnums.h for possible values).

Discussion

If an error occurred, call setError: first, then specify TICDSRemoteFileStructureExistsResponseTypeError for status.

Declared In

TICDSDocumentClientDeletionOperation.h

discoveredStatusOfClientIdentifierFileInDocumentRecentSyncsDirectory:

Indicate the status of the client’s file inside the document’s RecentSyncs directory.

- (void)discoveredStatusOfClientIdentifierFileInDocumentRecentSyncsDirectory:(TICDSRemoteFileStructureExistsResponseType)status

Parameters

status: The status of the directory: does exist, does not exist, or error (see TICDSTypesAndEnums.h for possible values).

Discussion

If an error occurred, call setError: first, then specify TICDSRemoteFileStructureExistsResponseTypeError for status.

Declared In

TICDSDocumentClientDeletionOperation.h