George Fedoseev

Go to Tutorial

DropboxSync v3.0 Documentation

Contents

• Downloading

  • GetFileAsLocalCachedPath()
  • GetFileAsBytes()
  • GetFile<T>()

• Uploading

  • UploadFile(string localFilePath)
  • UploadFile(byte[] bytes)

• KeepSynced

  • KeepSynced()
  • UnsubscribeFromKeepSyncCallback()
  • StopKeepingInSync()
  • IsKeepingInSync()

• Operations

  • CreateFolder()
  • ListFolder()
  • Move()
  • Delete()
  • PathExists()
  • GetMetadata()
  • ShouldUpdateFileFromDropbox()

Downloading

GetFileAsLocalCachedPath()

public async void GetFileAsLocalCachedPath(string dropboxPath, Progress<TransferProgressReport> progressCallback, Action<string> successCallback, Action<Exception> errorCallback, bool useCachedFirst = false, bool useCachedIfOffline = true, bool receiveUpdates = false, CancellationToken? cancellationToken = null)

Asynchronously retrieves file from Dropbox and returns path to local filesystem cached copy.

Parameters

Example usage

​x
_cancellationTokenSource = new CancellationTokenSource();
​
DropboxSync.Main.GetFileAsLocalCachedPath(inputField.text, 
  new Progress<TransferProgressReport>((report) => {                        
      statusText.text = $"Downloading: {report.progress}% {report.bytesPerSecondFormatted}";
  }),
  (localPath) => {
      // success
      print($"Completed");
      statusText.text = $"<color=green>Local path: {localPath}</color>";
  }, (ex) => {
      // exception
      if(ex is OperationCanceledException){
          Debug.Log("Download cancelled");
          statusText.text = $"<color=orange>Download canceled.</color>";
      }else{
          Debug.LogException(ex);
          statusText.text = $"<color=red>Download failed.</color>";
      }
  },
  cancellationToken: _cancellationTokenSource.Token);

Example usage (async)

xxxxxxxxxx
_cancellationTokenSource = new CancellationTokenSource();
​
try {
  var localPath = await DropboxSync.Main.GetFileAsLocalCachedPathAsync(inputField.text, 
  new Progress<TransferProgressReport>((report) => {                        
      print($"Downloading: {report.progress}% {report.bytesPerSecondFormatted}");
  }), _cancellationTokenSource.Token);
​
  print($"Completed");
}catch(Exception ex){
  if(ex is OperationCanceledException){
    print("Download cancelled");
  }else{
    Debug.LogException(ex);
  }
}

GetFileAsBytes()

xxxxxxxxxx
public void GetFileAsBytes(string dropboxPath, Progress<TransferProgressReport> progressCallback, Action<byte[]> successCallback, Action<Exception> errorCallback, bool useCachedFirst = false, bool useCachedIfOffline = true, bool receiveUpdates = false, CancellationToken? cancellationToken = null)

Asynchronously retrieves file from Dropbox and returns it as byte array

Parameters

GetFile<T>()

xxxxxxxxxx
public void GetFile<T>(string dropboxPath, Progress<TransferProgressReport> progressCallback, Action<T> successCallback, Action<Exception> errorCallback, bool useCachedFirst = false, bool useCachedIfOffline = true, bool receiveUpdates = false, CancellationToken? cancellationToken = null)

Retrieves file from Dropbox and returns it as T (T can be string, Texture2D or any type that can be deserialized from text using JsonUtility)

Parameters

Example usage

xxxxxxxxxx
DropboxSync.Main.GetFile<Texture2D>(EXAMPLE_IMAGE_PATH, 
  new Progress<TransferProgressReport>((progress) => {}), 
  (texture) => {      
    UpdatePicture(texture);     
  }, (ex) => {
    Debug.LogError($"Error getting picture from Dropbox: {ex}");
  }, receiveUpdates: true, useCachedFirst:true);

Uploading

UploadFile(string localFilePath)

xxxxxxxxxx
public async void UploadFile(string localFilePath, string dropboxPath, Progress<TransferProgressReport> progressCallback, Action<Metadata> successCallback, Action<Exception> errorCallback, CancellationToken? cancellationToken)

Uploads file from specified filepath in local filesystem to Dropbox

Parameters

Example usage

xxxxxxxxxx
_cancellationTokenSource  = new CancellationTokenSource();
​
DropboxSync.Main.UploadFile(LOCAL_FILE_PATH, DROPBOX_UPLOAD_PATH, 
  new Progress<TransferProgressReport>((report) => {
    print($"Uploading file {report.progress}% {report.bytesPerSecondFormatted}");           
  }), (metadata) => {
    // success      
    print($"Upload completed:\n{metadata}");
  }, (ex) => {
    // exception
    if(ex is OperationCanceledException){
      print("Upload cancelled");
    }else{
      Debug.LogException(ex);
    }
  }, _cancellationTokenSource.Token);

Example usage (async)

xxxxxxxxxx
_cancellationTokenSource  = new CancellationTokenSource();
    
try {
  var metadata = await DropboxSync.Main.UploadFileAsync(
    LOCAL_FILE_PATH, DROPBOX_UPLOAD_PATH, 
    new Progress<TransferProgressReport>((report) => {    
      print($"Uploading file {report.progress}% {report.bytesPerSecondFormatted}");
  }), _cancellationTokenSource.Token);
​
  print($"Upload completed:\n{metadata}");
  
}catch(Exception ex){
  if(ex is OperationCanceledException){
    print("Upload cancelled");
  }else{
    Debug.LogException(ex);
  }
}

UploadFile(byte[] bytes)

xxxxxxxxxx
public async void UploadFile(byte[] bytes, string dropboxPath, Progress<TransferProgressReport> progressCallback, Action<Metadata> successCallback, Action<Exception> errorCallback, CancellationToken? cancellationToken)

Uploads byte array to Dropbox

Parameters

Keeping in Sync

NOTE: Synchronization is only one way: Dropbox to Local cache

KeepSynced()

xxxxxxxxxx
public void KeepSynced(string dropboxPath, Action<EntryChange> syncedCallback)

Keep Dropbox file or folder synced (one-way: from Dropbox to Local cache)

Parameters

Example usage

xxxxxxxxxx
void Start() {
  DropboxSync.Main.KeepSynced(DROPBOX_PATH, OnChangeSynced);   
}
​
void OnChangeSynced(DBXSync.EntryChange change){
    print($"Change synced: {change}");
} 

UnsubscribeFromKeepSyncCallback()

xxxxxxxxxx
public void UnsubscribeFromKeepSyncCallback(string dropboxPath, Action<EntryChange> syncedCallback)

Unsubscribe specified callback from getting synced changes (if there will be no callbacks listening then syncing will automatically stop as well)

Parameters

StopKeepingInSync()

xxxxxxxxxx
public void StopKeepingInSync(string dropboxPath)

Stop keeping in sync Dropbox file or folder

Parameters

IsKeepingInSync()

xxxxxxxxxx
public bool IsKeepingInSync(string dropboxPath)

Checks if currently keeping Dropbox file of folder in sync

Parameters

Operations

CreateFolder()

xxxxxxxxxx
public async void CreateFolder(string dropboxFolderPath, Action<Metadata> successCallback, Action<Exception> errorCallback, bool autorename = false)

Creates folder on Dropbox

Parameters

ListFolder()

xxxxxxxxxx
public async void ListFolder(string dropboxFolderPath, Action<List<Metadata>> successCallback, Action<Exception> errorCallback, bool recursive = false) 

Get contents of the folder on Dropbox

Parameters

Move()

xxxxxxxxxx
public async void Move(string fromDropboxPath, string toDropboxPath, Action<Metadata> successCallback, Action<Exception> errorCallback, bool autorename = false) 

Move file or folder from one path to another

Parameters

Delete()

xxxxxxxxxx
public async void Delete(string dropboxPath, Action<Metadata> successCallback, Action<Exception> errorCallback)

Delete file or folder on Dropbox

Parameters

PathExists()

xxxxxxxxxx
public async void PathExists(string dropboxPath, Action<bool> successCallback, Action<Exception> errorCallback)

Checks if file or folder exists on Dropbox

Parameters

GetMetadata()

xxxxxxxxxx
public async void GetMetadata(string dropboxPath, Action<Metadata> successCallback, Action<Exception> errorCallback)

Get Metadata for file or folder on Dropbox

Parameters

ShouldUpdateFileFromDropbox()

xxxxxxxxxx
public async void ShouldUpdateFileFromDropbox(string dropboxFilePath, Action<bool> successCallback, Action<Exception> errorCallback)

Checks if Dropbox has different version of the file (always returns true if file is not cached locally)

Parameters