TICDSFileManagerBasedApplicationSyncManager Class Reference

Inherits from	TICDSApplicationSyncManager : NSObject
Declared in	TICDSFileManagerBasedApplicationSyncManager.h

Overview

The TICDSFileManagerBasedApplicationSyncManager describes a class used to synchronize an application 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

The only requirement is that you set the NSURL location of the directory that should contain the application before you register the sync manager. For example, if you wish to have sync information stored in ~/Dropbox/com.timisted.MySynchronizedApp/, specify ~/Dropbox as the applicationContainingDirectoryLocation.

Tasks

Dropbox-Related Methods

+ localDropboxDirectoryLocation
Returns the location of the user’s Dropbox directory, if one exists, by decoding the content in ~/.dropbox/host.db, as described at https://www.dropbox.com/developers/desktop_apps.

Properties

applicationContainingDirectoryLocation
The location of the directory that should contain the file structure for this application’s synchronization.
property

Paths

applicationDirectoryPath
The path to the root application directory.
property
deletedDocumentsDirectoryPath
The path to the DeletedDocuments directory inside the Information directory at the root of the application.
property
encryptionDirectorySaltDataFilePath
The path to the salt.ticdsync file inside the Encryption directory at the root of the application.
property
encryptionDirectoryTestDataFilePath
The path to the test.ticdsync file inside the Encryption directory at the root of the application.
property
documentsDirectoryPath
The path to the Documents directory at the root of the application.
property
clientDevicesDirectoryPath
The path to the ClientDevices directory at the root of the application.
property
clientDevicesThisClientDeviceDirectoryPath
The path to this client’s directory inside the ClientDevices directory at the root of the application.
property
– pathToWholeStoreDirectoryForDocumentWithIdentifier:
The path to the WholeStore directory for a document with a given identifier.

Properties

applicationContainingDirectoryLocation

The location of the directory that should contain the file structure for this application’s synchronization.

@property (nonatomic, retain) NSURL *applicationContainingDirectoryLocation

Declared In

TICDSFileManagerBasedApplicationSyncManager.h

applicationDirectoryPath

The path to the root application directory.

@property (nonatomic, readonly) NSString *applicationDirectoryPath

Declared In

TICDSFileManagerBasedApplicationSyncManager.h

clientDevicesDirectoryPath

The path to the ClientDevices directory at the root of the application.

@property (nonatomic, readonly) NSString *clientDevicesDirectoryPath

Declared In

TICDSFileManagerBasedApplicationSyncManager.h

clientDevicesThisClientDeviceDirectoryPath

The path to this client’s directory inside the ClientDevices directory at the root of the application.

@property (nonatomic, readonly) NSString *clientDevicesThisClientDeviceDirectoryPath

Declared In

TICDSFileManagerBasedApplicationSyncManager.h

deletedDocumentsDirectoryPath

The path to the DeletedDocuments directory inside the Information directory at the root of the application.

@property (nonatomic, readonly) NSString *deletedDocumentsDirectoryPath

Declared In

TICDSFileManagerBasedApplicationSyncManager.h

documentsDirectoryPath

The path to the Documents directory at the root of the application.

@property (nonatomic, readonly) NSString *documentsDirectoryPath

Declared In

TICDSFileManagerBasedApplicationSyncManager.h

encryptionDirectorySaltDataFilePath

The path to the salt.ticdsync file inside the Encryption directory at the root of the application.

@property (nonatomic, readonly) NSString *encryptionDirectorySaltDataFilePath

Declared In

TICDSFileManagerBasedApplicationSyncManager.h

encryptionDirectoryTestDataFilePath

The path to the test.ticdsync file inside the Encryption directory at the root of the application.

@property (nonatomic, readonly) NSString *encryptionDirectoryTestDataFilePath

Declared In

TICDSFileManagerBasedApplicationSyncManager.h

Class Methods

localDropboxDirectoryLocation

Returns the location of the user’s Dropbox directory, if one exists, by decoding the content in ~/.dropbox/host.db, as described at https://www.dropbox.com/developers/desktop_apps.

+ (NSURL *)localDropboxDirectoryLocation

Return Value

The location of the user’s Dropbox directory, or nil if no path could be found.

Discussion

This procedure has been marked “will likely be deprecated” by Dropbox. Do not rely on this as the only way to get hold of the user’s Dropbox directory, and do not use it without checking with the user that it is the correct location.

Declared In

TICDSFileManagerBasedApplicationSyncManager.h

Instance Methods

pathToWholeStoreDirectoryForDocumentWithIdentifier:

The path to the WholeStore directory for a document with a given identifier.

- (NSString *)pathToWholeStoreDirectoryForDocumentWithIdentifier:(NSString *)anIdentifier

Parameters

anIdentifier: The unique sync identifier of the document.

Declared In

TICDSFileManagerBasedApplicationSyncManager.h