TICDSFileManagerBasedDocumentSyncManager Class Reference
| 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:
- Dropbox on the desktop (files are typically accessed via
~/Dropbox) - 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
-
– enableAutomaticSynchronizationAfterChangesDetectedFromOtherClientsConfigures 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.
Properties
-
directoryWatcherA
propertyTIKQDirectoryWatcherused to watch for changes in theSyncChangesdirectories for this document. -
watchedClientDirectoryIdentifiersA mutable array containing the identifiers of clients currently being watched.
property
Paths
-
applicationDirectoryPathThe path to the root of the application. This will be set automatically when you register and supply a
propertyTICDSFileManagerBasedApplicationSyncManager. -
clientDevicesDirectoryPathThe path to the
propertyClientDevicesdirectory. -
deletedDocumentsThisDocumentIdentifierPlistPathThe path to this document’s
propertyidentifier.plistfile inside theDeletedDocumentsdirectory. -
documentsDirectoryPathThe path to the
propertyDocumentsdirectory. -
thisDocumentDirectoryPathThe path to this document’s directory inside the
propertyDocumentsdirectory. -
thisDocumentDeletedClientsDirectoryPathThe path to this document’s
propertyDeletedClientsdirectory. -
thisDocumentSyncChangesDirectoryPathThe path to this document’s
propertySyncChangesdirectory. -
thisDocumentSyncChangesThisClientDirectoryPathThe path to this client’s directory inside this document’s
propertySyncChangesdirectory. -
thisDocumentSyncCommandsDirectoryPathThe path to this document’s
propertySyncCommandsdirectory. -
thisDocumentSyncCommandsThisClientDirectoryPathThe path to this client’s directory inside this document’s
propertySyncCommandsdirectory. -
thisDocumentTemporaryWholeStoreThisClientDirectoryPathThe path to this client’s temporary
propertyWholeStoredirectory. -
thisDocumentTemporaryWholeStoreFilePathThe path to this client’s temporary
propertyWholeStore.ticdsyncfile. -
thisDocumentTemporaryAppliedSyncChangeSetsFilePathThe path to this client’s temporary
propertyAppliedSyncChangeSets.ticdsyncfile. -
thisDocumentWholeStoreDirectoryPathThe path to this document’s
propertyWholeStoredirectory. -
thisDocumentWholeStoreThisClientDirectoryPathThe path to this client’s directory inside this document’s
propertyWholeStoredirectory. -
thisDocumentWholeStoreFilePathThe path to this client’s
propertyWholeStore.ticdsyncfile. -
thisDocumentAppliedSyncChangeSetsFilePathThe path to this client’s
propertyAppliedSyncChangeSets.ticdsyncfile. -
thisDocumentRecentSyncsDirectoryPathThe path to this document’s
propertyRecentSyncsdirectory. -
thisDocumentRecentSyncsThisClientFilePathThe path to this client’s RecentSync file inside this document’s
propertyRecentSyncsdirectory.
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 *applicationDirectoryPathDeclared In
TICDSFileManagerBasedDocumentSyncManager.hclientDevicesDirectoryPath
The path to the ClientDevices directory.
@property (nonatomic, readonly) NSString *clientDevicesDirectoryPathDeclared In
TICDSFileManagerBasedDocumentSyncManager.hdeletedDocumentsThisDocumentIdentifierPlistPath
The path to this document’s identifier.plist file inside the DeletedDocuments directory.
@property (nonatomic, readonly) NSString *deletedDocumentsThisDocumentIdentifierPlistPathDeclared In
TICDSFileManagerBasedDocumentSyncManager.hdirectoryWatcher
A TIKQDirectoryWatcher used to watch for changes in the SyncChanges directories for this document.
@property (nonatomic, readonly) TIKQDirectoryWatcher *directoryWatcherDeclared In
TICDSFileManagerBasedDocumentSyncManager.hdocumentsDirectoryPath
The path to the Documents directory.
@property (nonatomic, readonly) NSString *documentsDirectoryPathDeclared In
TICDSFileManagerBasedDocumentSyncManager.hthisDocumentAppliedSyncChangeSetsFilePath
The path to this client’s AppliedSyncChangeSets.ticdsync file.
@property (nonatomic, readonly) NSString *thisDocumentAppliedSyncChangeSetsFilePathDeclared In
TICDSFileManagerBasedDocumentSyncManager.hthisDocumentDeletedClientsDirectoryPath
The path to this document’s DeletedClients directory.
@property (nonatomic, readonly) NSString *thisDocumentDeletedClientsDirectoryPathDeclared In
TICDSFileManagerBasedDocumentSyncManager.hthisDocumentDirectoryPath
The path to this document’s directory inside the Documents directory.
@property (nonatomic, readonly) NSString *thisDocumentDirectoryPathDeclared In
TICDSFileManagerBasedDocumentSyncManager.hthisDocumentRecentSyncsDirectoryPath
The path to this document’s RecentSyncs directory.
@property (nonatomic, readonly) NSString *thisDocumentRecentSyncsDirectoryPathDeclared In
TICDSFileManagerBasedDocumentSyncManager.hthisDocumentRecentSyncsThisClientFilePath
The path to this client’s RecentSync file inside this document’s RecentSyncs directory.
@property (nonatomic, readonly) NSString *thisDocumentRecentSyncsThisClientFilePathDeclared In
TICDSFileManagerBasedDocumentSyncManager.hthisDocumentSyncChangesDirectoryPath
The path to this document’s SyncChanges directory.
@property (nonatomic, readonly) NSString *thisDocumentSyncChangesDirectoryPathDeclared In
TICDSFileManagerBasedDocumentSyncManager.hthisDocumentSyncChangesThisClientDirectoryPath
The path to this client’s directory inside this document’s SyncChanges directory.
@property (nonatomic, readonly) NSString *thisDocumentSyncChangesThisClientDirectoryPathDeclared In
TICDSFileManagerBasedDocumentSyncManager.hthisDocumentSyncCommandsDirectoryPath
The path to this document’s SyncCommands directory.
@property (nonatomic, readonly) NSString *thisDocumentSyncCommandsDirectoryPathDeclared In
TICDSFileManagerBasedDocumentSyncManager.hthisDocumentSyncCommandsThisClientDirectoryPath
The path to this client’s directory inside this document’s SyncCommands directory.
@property (nonatomic, readonly) NSString *thisDocumentSyncCommandsThisClientDirectoryPathDeclared In
TICDSFileManagerBasedDocumentSyncManager.hthisDocumentTemporaryAppliedSyncChangeSetsFilePath
The path to this client’s temporary AppliedSyncChangeSets.ticdsync file.
@property (nonatomic, readonly) NSString *thisDocumentTemporaryAppliedSyncChangeSetsFilePathDeclared In
TICDSFileManagerBasedDocumentSyncManager.hthisDocumentTemporaryWholeStoreFilePath
The path to this client’s temporary WholeStore.ticdsync file.
@property (nonatomic, readonly) NSString *thisDocumentTemporaryWholeStoreFilePathDeclared In
TICDSFileManagerBasedDocumentSyncManager.hthisDocumentTemporaryWholeStoreThisClientDirectoryPath
The path to this client’s temporary WholeStore directory.
@property (nonatomic, readonly) NSString *thisDocumentTemporaryWholeStoreThisClientDirectoryPathDeclared In
TICDSFileManagerBasedDocumentSyncManager.hthisDocumentWholeStoreDirectoryPath
The path to this document’s WholeStore directory.
@property (nonatomic, readonly) NSString *thisDocumentWholeStoreDirectoryPathDeclared In
TICDSFileManagerBasedDocumentSyncManager.hthisDocumentWholeStoreFilePath
The path to this client’s WholeStore.ticdsync file.
@property (nonatomic, readonly) NSString *thisDocumentWholeStoreFilePathDeclared In
TICDSFileManagerBasedDocumentSyncManager.hInstance 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)enableAutomaticSynchronizationAfterChangesDetectedFromOtherClientsDeclared In
TICDSFileManagerBasedDocumentSyncManager.h