Inherits from TICDSDocumentSyncManager : NSObject
Declared in TICDSFileManagerBasedDocumentSyncManager.h

Overview

The TICDSFileManagerBasedDocumentSyncManager describes a class used to synchronize documents with a remote service that can be accessed via an NSFileManager. This includes:

  1. Dropbox on the desktop (files are typically accessed via ~/Dropbox)
  2. iDisk on the desktop

No FileManagerBased-specific settings are required when you create a TICDSFileManagerBasedDocumentSyncManager—the applicationDirectoryPath is set automatically when you register (based on the properties set on the TICDSFileManagerBasedApplicationSyncManager).

One additional feature is provided by an NSFileManager-based document sync manager—-the ability to trigger a synchronization whenever changes are detected in other clients' SyncChanges directories. To make use of this functionality, simply call the enableAutomaticSynchronizationAfterChangesDetectedFromOtherClients method once the document has been registered.

Tasks

Automatic Change Detection

Properties

Paths

Properties

applicationDirectoryPath

The path to the root of the application. This will be set automatically when you register and supply a TICDSFileManagerBasedApplicationSyncManager.

@property (nonatomic, retain) NSString *applicationDirectoryPath

Declared In

TICDSFileManagerBasedDocumentSyncManager.h

clientDevicesDirectoryPath

The path to the ClientDevices directory.

@property (nonatomic, readonly) NSString *clientDevicesDirectoryPath

Declared In

TICDSFileManagerBasedDocumentSyncManager.h

deletedDocumentsThisDocumentIdentifierPlistPath

The path to this document’s identifier.plist file inside the DeletedDocuments directory.

@property (nonatomic, readonly) NSString *deletedDocumentsThisDocumentIdentifierPlistPath

Declared In

TICDSFileManagerBasedDocumentSyncManager.h

directoryWatcher

A TIKQDirectoryWatcher used to watch for changes in the SyncChanges directories for this document.

@property (nonatomic, readonly) TIKQDirectoryWatcher *directoryWatcher

Declared In

TICDSFileManagerBasedDocumentSyncManager.h

documentsDirectoryPath

The path to the Documents directory.

@property (nonatomic, readonly) NSString *documentsDirectoryPath

Declared In

TICDSFileManagerBasedDocumentSyncManager.h

thisDocumentAppliedSyncChangeSetsFilePath

The path to this client’s AppliedSyncChangeSets.ticdsync file.

@property (nonatomic, readonly) NSString *thisDocumentAppliedSyncChangeSetsFilePath

Declared In

TICDSFileManagerBasedDocumentSyncManager.h

thisDocumentDeletedClientsDirectoryPath

The path to this document’s DeletedClients directory.

@property (nonatomic, readonly) NSString *thisDocumentDeletedClientsDirectoryPath

Declared In

TICDSFileManagerBasedDocumentSyncManager.h

thisDocumentDirectoryPath

The path to this document’s directory inside the Documents directory.

@property (nonatomic, readonly) NSString *thisDocumentDirectoryPath

Declared In

TICDSFileManagerBasedDocumentSyncManager.h

thisDocumentRecentSyncsDirectoryPath

The path to this document’s RecentSyncs directory.

@property (nonatomic, readonly) NSString *thisDocumentRecentSyncsDirectoryPath

Declared In

TICDSFileManagerBasedDocumentSyncManager.h

thisDocumentRecentSyncsThisClientFilePath

The path to this client’s RecentSync file inside this document’s RecentSyncs directory.

@property (nonatomic, readonly) NSString *thisDocumentRecentSyncsThisClientFilePath

Declared In

TICDSFileManagerBasedDocumentSyncManager.h

thisDocumentSyncChangesDirectoryPath

The path to this document’s SyncChanges directory.

@property (nonatomic, readonly) NSString *thisDocumentSyncChangesDirectoryPath

Declared In

TICDSFileManagerBasedDocumentSyncManager.h

thisDocumentSyncChangesThisClientDirectoryPath

The path to this client’s directory inside this document’s SyncChanges directory.

@property (nonatomic, readonly) NSString *thisDocumentSyncChangesThisClientDirectoryPath

Declared In

TICDSFileManagerBasedDocumentSyncManager.h

thisDocumentSyncCommandsDirectoryPath

The path to this document’s SyncCommands directory.

@property (nonatomic, readonly) NSString *thisDocumentSyncCommandsDirectoryPath

Declared In

TICDSFileManagerBasedDocumentSyncManager.h

thisDocumentSyncCommandsThisClientDirectoryPath

The path to this client’s directory inside this document’s SyncCommands directory.

@property (nonatomic, readonly) NSString *thisDocumentSyncCommandsThisClientDirectoryPath

Declared In

TICDSFileManagerBasedDocumentSyncManager.h

thisDocumentTemporaryAppliedSyncChangeSetsFilePath

The path to this client’s temporary AppliedSyncChangeSets.ticdsync file.

@property (nonatomic, readonly) NSString *thisDocumentTemporaryAppliedSyncChangeSetsFilePath

Declared In

TICDSFileManagerBasedDocumentSyncManager.h

thisDocumentTemporaryWholeStoreFilePath

The path to this client’s temporary WholeStore.ticdsync file.

@property (nonatomic, readonly) NSString *thisDocumentTemporaryWholeStoreFilePath

Declared In

TICDSFileManagerBasedDocumentSyncManager.h

thisDocumentTemporaryWholeStoreThisClientDirectoryPath

The path to this client’s temporary WholeStore directory.

@property (nonatomic, readonly) NSString *thisDocumentTemporaryWholeStoreThisClientDirectoryPath

Declared In

TICDSFileManagerBasedDocumentSyncManager.h

thisDocumentWholeStoreDirectoryPath

The path to this document’s WholeStore directory.

@property (nonatomic, readonly) NSString *thisDocumentWholeStoreDirectoryPath

Declared In

TICDSFileManagerBasedDocumentSyncManager.h

thisDocumentWholeStoreFilePath

The path to this client’s WholeStore.ticdsync file.

@property (nonatomic, readonly) NSString *thisDocumentWholeStoreFilePath

Declared In

TICDSFileManagerBasedDocumentSyncManager.h

thisDocumentWholeStoreThisClientDirectoryPath

The path to this client’s directory inside this document’s WholeStore directory.

@property (nonatomic, readonly) NSString *thisDocumentWholeStoreThisClientDirectoryPath

Declared In

TICDSFileManagerBasedDocumentSyncManager.h

watchedClientDirectoryIdentifiers

A mutable array containing the identifiers of clients currently being watched.

@property (nonatomic, readonly) NSMutableArray *watchedClientDirectoryIdentifiers

Declared In

TICDSFileManagerBasedDocumentSyncManager.h

Instance Methods

enableAutomaticSynchronizationAfterChangesDetectedFromOtherClients

Configures the FileManager-based document sync manager to watch for changes uploaded by other clients, and initiate a sync operation automatically when new changes are detected.

- (void)enableAutomaticSynchronizationAfterChangesDetectedFromOtherClients

Declared In

TICDSFileManagerBasedDocumentSyncManager.h