Click or drag to resize

FilesUserRoutes Class

The routes for the Dropbox.Api.Files namespace

Inheritance Hierarchy
SystemObject
  Dropbox.Api.Files.RoutesFilesUserRoutes

Namespace:  Dropbox.Api.Files.Routes
Assembly:  Dropbox.Api (in Dropbox.Api.dll) Version: 5.0
Syntax
public class FilesUserRoutes

The FilesUserRoutes type exposes the following members.

Methods
  NameDescription
Public methodAlphaGetMetadataAsync(AlphaGetMetadataArg) Obsolete.

Returns the metadata for a file or folder. This is an alpha endpoint compatible with the properties API.

Note: Metadata for the root folder is unsupported.

Public methodAlphaGetMetadataAsync(String, Boolean, Boolean, Boolean, TemplateFilterBase, IEnumerableString) Obsolete.

Returns the metadata for a file or folder. This is an alpha endpoint compatible with the properties API.

Note: Metadata for the root folder is unsupported.

Public methodAlphaUploadAsync(CommitInfoWithProperties, Stream) Obsolete.

Create a new file with the contents provided in the request. Note that this endpoint is part of the properties API alpha and is slightly different from UploadAsync(CommitInfo, Stream).

Do not use this to upload a file larger than 150 MB. Instead, create an upload session with UploadSessionStartAsync(UploadSessionStartArg, Stream).

Public methodAlphaUploadAsync(String, WriteMode, Boolean, NullableDateTime, Boolean, IEnumerablePropertyGroup, Boolean, Stream) Obsolete.

Create a new file with the contents provided in the request. Note that this endpoint is part of the properties API alpha and is slightly different from UploadAsync(CommitInfo, Stream).

Do not use this to upload a file larger than 150 MB. Instead, create an upload session with UploadSessionStartAsync(UploadSessionStartArg, Stream).

Public methodBeginAlphaGetMetadata(AlphaGetMetadataArg, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the alpha get metadata route.

Public methodBeginAlphaGetMetadata(String, Boolean, Boolean, Boolean, TemplateFilterBase, IEnumerableString, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the alpha get metadata route.

Public methodBeginAlphaUpload(CommitInfoWithProperties, Stream, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the alpha upload route.

Public methodBeginAlphaUpload(String, WriteMode, Boolean, NullableDateTime, Boolean, IEnumerablePropertyGroup, Boolean, Stream, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the alpha upload route.

Public methodBeginCopy(RelocationArg, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the copy route.

Public methodBeginCopy(String, String, Boolean, Boolean, Boolean, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the copy route.

Public methodBeginCopyBatch(RelocationBatchArg, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the copy batch route.

Public methodBeginCopyBatch(IEnumerableRelocationPath, Boolean, Boolean, Boolean, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the copy batch route.

Public methodBeginCopyBatchCheck(String, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the copy batch check route.

Public methodBeginCopyBatchCheck(PollArg, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the copy batch check route.

Public methodBeginCopyBatchCheckV2(String, AsyncCallback, Object)

Begins an asynchronous send to the copy batch check route.

Public methodBeginCopyBatchCheckV2(PollArg, AsyncCallback, Object)

Begins an asynchronous send to the copy batch check route.

Public methodBeginCopyBatchV2(RelocationBatchArgBase, AsyncCallback, Object)

Begins an asynchronous send to the copy batch route.

Public methodBeginCopyBatchV2(IEnumerableRelocationPath, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the copy batch route.

Public methodBeginCopyReferenceGet(String, AsyncCallback, Object)

Begins an asynchronous send to the copy reference get route.

Public methodBeginCopyReferenceGet(GetCopyReferenceArg, AsyncCallback, Object)

Begins an asynchronous send to the copy reference get route.

Public methodBeginCopyReferenceSave(SaveCopyReferenceArg, AsyncCallback, Object)

Begins an asynchronous send to the copy reference save route.

Public methodBeginCopyReferenceSave(String, String, AsyncCallback, Object)

Begins an asynchronous send to the copy reference save route.

Public methodBeginCopyV2(RelocationArg, AsyncCallback, Object)

Begins an asynchronous send to the copy route.

Public methodBeginCopyV2(String, String, Boolean, Boolean, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the copy route.

Public methodBeginCreateFolder(CreateFolderArg, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the create folder route.

Public methodBeginCreateFolder(String, Boolean, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the create folder route.

Public methodBeginCreateFolderBatch(CreateFolderBatchArg, AsyncCallback, Object)

Begins an asynchronous send to the create folder batch route.

Public methodBeginCreateFolderBatch(IEnumerableString, Boolean, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the create folder batch route.

Public methodBeginCreateFolderBatchCheck(String, AsyncCallback, Object)

Begins an asynchronous send to the create folder batch check route.

Public methodBeginCreateFolderBatchCheck(PollArg, AsyncCallback, Object)

Begins an asynchronous send to the create folder batch check route.

Public methodBeginCreateFolderV2(CreateFolderArg, AsyncCallback, Object)

Begins an asynchronous send to the create folder route.

Public methodBeginCreateFolderV2(String, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the create folder route.

Public methodBeginDelete(DeleteArg, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the delete route.

Public methodBeginDelete(String, String, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the delete route.

Public methodBeginDeleteBatch(IEnumerableDeleteArg, AsyncCallback, Object)

Begins an asynchronous send to the delete batch route.

Public methodBeginDeleteBatch(DeleteBatchArg, AsyncCallback, Object)

Begins an asynchronous send to the delete batch route.

Public methodBeginDeleteBatchCheck(String, AsyncCallback, Object)

Begins an asynchronous send to the delete batch check route.

Public methodBeginDeleteBatchCheck(PollArg, AsyncCallback, Object)

Begins an asynchronous send to the delete batch check route.

Public methodBeginDeleteV2(DeleteArg, AsyncCallback, Object)

Begins an asynchronous send to the delete route.

Public methodBeginDeleteV2(String, String, AsyncCallback, Object)

Begins an asynchronous send to the delete route.

Public methodBeginDownload(DownloadArg, AsyncCallback, Object)

Begins an asynchronous send to the download route.

Public methodBeginDownload(String, String, AsyncCallback, Object)

Begins an asynchronous send to the download route.

Public methodBeginDownloadZip(String, AsyncCallback, Object)

Begins an asynchronous send to the download zip route.

Public methodBeginDownloadZip(DownloadZipArg, AsyncCallback, Object)

Begins an asynchronous send to the download zip route.

Public methodBeginExport(String, AsyncCallback, Object)

Begins an asynchronous send to the export route.

Public methodBeginExport(ExportArg, AsyncCallback, Object)

Begins an asynchronous send to the export route.

Public methodBeginGetFileLockBatch(IEnumerableLockFileArg, AsyncCallback, Object)

Begins an asynchronous send to the get file lock batch route.

Public methodBeginGetFileLockBatch(LockFileBatchArg, AsyncCallback, Object)

Begins an asynchronous send to the get file lock batch route.

Public methodBeginGetMetadata(GetMetadataArg, AsyncCallback, Object)

Begins an asynchronous send to the get metadata route.

Public methodBeginGetMetadata(String, Boolean, Boolean, Boolean, TemplateFilterBase, AsyncCallback, Object)

Begins an asynchronous send to the get metadata route.

Public methodBeginGetPreview(PreviewArg, AsyncCallback, Object)

Begins an asynchronous send to the get preview route.

Public methodBeginGetPreview(String, String, AsyncCallback, Object)

Begins an asynchronous send to the get preview route.

Public methodBeginGetTemporaryLink(String, AsyncCallback, Object)

Begins an asynchronous send to the get temporary link route.

Public methodBeginGetTemporaryLink(GetTemporaryLinkArg, AsyncCallback, Object)

Begins an asynchronous send to the get temporary link route.

Public methodBeginGetTemporaryUploadLink(GetTemporaryUploadLinkArg, AsyncCallback, Object)

Begins an asynchronous send to the get temporary upload link route.

Public methodBeginGetTemporaryUploadLink(CommitInfo, Double, AsyncCallback, Object)

Begins an asynchronous send to the get temporary upload link route.

Public methodBeginGetThumbnail(ThumbnailArg, AsyncCallback, Object)

Begins an asynchronous send to the get thumbnail route.

Public methodBeginGetThumbnail(String, ThumbnailFormat, ThumbnailSize, ThumbnailMode, AsyncCallback, Object)

Begins an asynchronous send to the get thumbnail route.

Public methodBeginGetThumbnailBatch(GetThumbnailBatchArg, AsyncCallback, Object)

Begins an asynchronous send to the get thumbnail batch route.

Public methodBeginGetThumbnailBatch(IEnumerableThumbnailArg, AsyncCallback, Object)

Begins an asynchronous send to the get thumbnail batch route.

Public methodBeginGetThumbnailV2(ThumbnailV2Arg, AsyncCallback, Object)

Begins an asynchronous send to the get thumbnail route.

Public methodBeginGetThumbnailV2(PathOrLink, ThumbnailFormat, ThumbnailSize, ThumbnailMode, AsyncCallback, Object)

Begins an asynchronous send to the get thumbnail route.

Public methodBeginListFolder(ListFolderArg, AsyncCallback, Object)

Begins an asynchronous send to the list folder route.

Public methodBeginListFolder(String, Boolean, Boolean, Boolean, Boolean, Boolean, NullableUInt32, SharedLink, TemplateFilterBase, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the list folder route.

Public methodBeginListFolderContinue(String, AsyncCallback, Object)

Begins an asynchronous send to the list folder continue route.

Public methodBeginListFolderContinue(ListFolderContinueArg, AsyncCallback, Object)

Begins an asynchronous send to the list folder continue route.

Public methodBeginListFolderGetLatestCursor(ListFolderArg, AsyncCallback, Object)

Begins an asynchronous send to the list folder get latest cursor route.

Public methodBeginListFolderGetLatestCursor(String, Boolean, Boolean, Boolean, Boolean, Boolean, NullableUInt32, SharedLink, TemplateFilterBase, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the list folder get latest cursor route.

Public methodBeginListFolderLongpoll(ListFolderLongpollArg, AsyncCallback, Object)

Begins an asynchronous send to the list folder longpoll route.

Public methodBeginListFolderLongpoll(String, UInt64, AsyncCallback, Object)

Begins an asynchronous send to the list folder longpoll route.

Public methodBeginListRevisions(ListRevisionsArg, AsyncCallback, Object)

Begins an asynchronous send to the list revisions route.

Public methodBeginListRevisions(String, ListRevisionsMode, UInt64, AsyncCallback, Object)

Begins an asynchronous send to the list revisions route.

Public methodBeginLockFileBatch(IEnumerableLockFileArg, AsyncCallback, Object)

Begins an asynchronous send to the lock file batch route.

Public methodBeginLockFileBatch(LockFileBatchArg, AsyncCallback, Object)

Begins an asynchronous send to the lock file batch route.

Public methodBeginMove(RelocationArg, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the move route.

Public methodBeginMove(String, String, Boolean, Boolean, Boolean, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the move route.

Public methodBeginMoveBatch(RelocationBatchArg, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the move batch route.

Public methodBeginMoveBatch(IEnumerableRelocationPath, Boolean, Boolean, Boolean, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the move batch route.

Public methodBeginMoveBatchCheck(String, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the move batch check route.

Public methodBeginMoveBatchCheck(PollArg, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the move batch check route.

Public methodBeginMoveBatchCheckV2(String, AsyncCallback, Object)

Begins an asynchronous send to the move batch check route.

Public methodBeginMoveBatchCheckV2(PollArg, AsyncCallback, Object)

Begins an asynchronous send to the move batch check route.

Public methodBeginMoveBatchV2(MoveBatchArg, AsyncCallback, Object)

Begins an asynchronous send to the move batch route.

Public methodBeginMoveBatchV2(IEnumerableRelocationPath, Boolean, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the move batch route.

Public methodBeginMoveV2(RelocationArg, AsyncCallback, Object)

Begins an asynchronous send to the move route.

Public methodBeginMoveV2(String, String, Boolean, Boolean, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the move route.

Public methodBeginPermanentlyDelete(DeleteArg, AsyncCallback, Object)

Begins an asynchronous send to the permanently delete route.

Public methodBeginPermanentlyDelete(String, String, AsyncCallback, Object)

Begins an asynchronous send to the permanently delete route.

Public methodBeginPropertiesAdd(AddPropertiesArg, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the properties add route.

Public methodBeginPropertiesAdd(String, IEnumerablePropertyGroup, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the properties add route.

Public methodBeginPropertiesOverwrite(OverwritePropertyGroupArg, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the properties overwrite route.

Public methodBeginPropertiesOverwrite(String, IEnumerablePropertyGroup, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the properties overwrite route.

Public methodBeginPropertiesRemove(RemovePropertiesArg, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the properties remove route.

Public methodBeginPropertiesRemove(String, IEnumerableString, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the properties remove route.

Public methodBeginPropertiesTemplateGet(String, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the properties template get route.

Public methodBeginPropertiesTemplateGet(GetTemplateArg, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the properties template get route.

Public methodBeginPropertiesTemplateList Obsolete.

Begins an asynchronous send to the properties template list route.

Public methodBeginPropertiesUpdate(UpdatePropertiesArg, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the properties update route.

Public methodBeginPropertiesUpdate(String, IEnumerablePropertyGroupUpdate, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the properties update route.

Public methodBeginRestore(RestoreArg, AsyncCallback, Object)

Begins an asynchronous send to the restore route.

Public methodBeginRestore(String, String, AsyncCallback, Object)

Begins an asynchronous send to the restore route.

Public methodBeginSaveUrl(SaveUrlArg, AsyncCallback, Object)

Begins an asynchronous send to the save url route.

Public methodBeginSaveUrl(String, String, AsyncCallback, Object)

Begins an asynchronous send to the save url route.

Public methodBeginSaveUrlCheckJobStatus(String, AsyncCallback, Object)

Begins an asynchronous send to the save url check job status route.

Public methodBeginSaveUrlCheckJobStatus(PollArg, AsyncCallback, Object)

Begins an asynchronous send to the save url check job status route.

Public methodBeginSearch(SearchArg, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the search route.

Public methodBeginSearch(String, String, UInt64, UInt64, SearchMode, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the search route.

Public methodBeginSearchContinueV2(String, AsyncCallback, Object)

Begins an asynchronous send to the search continue route.

Public methodBeginSearchContinueV2(SearchV2ContinueArg, AsyncCallback, Object)

Begins an asynchronous send to the search continue route.

Public methodBeginSearchV2(SearchV2Arg, AsyncCallback, Object)

Begins an asynchronous send to the search route.

Public methodBeginSearchV2(String, SearchOptions, SearchMatchFieldOptions, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the search route.

Public methodBeginUnlockFileBatch(IEnumerableUnlockFileArg, AsyncCallback, Object)

Begins an asynchronous send to the unlock file batch route.

Public methodBeginUnlockFileBatch(UnlockFileBatchArg, AsyncCallback, Object)

Begins an asynchronous send to the unlock file batch route.

Public methodBeginUpload(CommitInfo, Stream, AsyncCallback, Object)

Begins an asynchronous send to the upload route.

Public methodBeginUpload(String, WriteMode, Boolean, NullableDateTime, Boolean, IEnumerablePropertyGroup, Boolean, Stream, AsyncCallback, Object)

Begins an asynchronous send to the upload route.

Public methodBeginUploadSessionAppend(UploadSessionCursor, Stream, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the upload session append route.

Public methodBeginUploadSessionAppend(String, UInt64, Stream, AsyncCallback, Object) Obsolete.

Begins an asynchronous send to the upload session append route.

Public methodBeginUploadSessionAppendV2(UploadSessionAppendArg, Stream, AsyncCallback, Object)

Begins an asynchronous send to the upload session append route.

Public methodBeginUploadSessionAppendV2(UploadSessionCursor, Boolean, Stream, AsyncCallback, Object)

Begins an asynchronous send to the upload session append route.

Public methodBeginUploadSessionFinish(UploadSessionFinishArg, Stream, AsyncCallback, Object)

Begins an asynchronous send to the upload session finish route.

Public methodBeginUploadSessionFinish(UploadSessionCursor, CommitInfo, Stream, AsyncCallback, Object)

Begins an asynchronous send to the upload session finish route.

Public methodBeginUploadSessionFinishBatch(IEnumerableUploadSessionFinishArg, AsyncCallback, Object)

Begins an asynchronous send to the upload session finish batch route.

Public methodBeginUploadSessionFinishBatch(UploadSessionFinishBatchArg, AsyncCallback, Object)

Begins an asynchronous send to the upload session finish batch route.

Public methodBeginUploadSessionFinishBatchCheck(String, AsyncCallback, Object)

Begins an asynchronous send to the upload session finish batch check route.

Public methodBeginUploadSessionFinishBatchCheck(PollArg, AsyncCallback, Object)

Begins an asynchronous send to the upload session finish batch check route.

Public methodBeginUploadSessionStart(Boolean, Stream, AsyncCallback, Object)

Begins an asynchronous send to the upload session start route.

Public methodBeginUploadSessionStart(UploadSessionStartArg, Stream, AsyncCallback, Object)

Begins an asynchronous send to the upload session start route.

Public methodCopyAsync(RelocationArg) Obsolete.

Copy a file or folder to a different location in the user's Dropbox.

If the source path is a folder all its contents will be copied.

Public methodCopyAsync(String, String, Boolean, Boolean, Boolean) Obsolete.

Copy a file or folder to a different location in the user's Dropbox.

If the source path is a folder all its contents will be copied.

Public methodCopyBatchAsync(RelocationBatchArg) Obsolete.

Copy multiple files or folders to different locations at once in the user's Dropbox.

If AllowSharedFolder is false, this route is atomic. If one entry fails, the whole transaction will abort. If AllowSharedFolder is true, atomicity is not guaranteed, but it allows you to copy the contents of shared folders to new locations.

This route will return job ID immediately and do the async copy job in background. Please use CopyBatchCheckAsync(PollArg) to check the job status.

Public methodCopyBatchAsync(IEnumerableRelocationPath, Boolean, Boolean, Boolean) Obsolete.

Copy multiple files or folders to different locations at once in the user's Dropbox.

If AllowSharedFolder is false, this route is atomic. If one entry fails, the whole transaction will abort. If AllowSharedFolder is true, atomicity is not guaranteed, but it allows you to copy the contents of shared folders to new locations.

This route will return job ID immediately and do the async copy job in background. Please use CopyBatchCheckAsync(PollArg) to check the job status.

Public methodCopyBatchCheckAsync(String) Obsolete.

Returns the status of an asynchronous job for CopyBatchAsync(RelocationBatchArg). If success, it returns list of results for each entry.

Public methodCopyBatchCheckAsync(PollArg) Obsolete.

Returns the status of an asynchronous job for CopyBatchAsync(RelocationBatchArg). If success, it returns list of results for each entry.

Public methodCopyBatchCheckV2Async(String)

Returns the status of an asynchronous job for CopyBatchV2Async(RelocationBatchArgBase). It returns list of results for each entry.

Public methodCopyBatchCheckV2Async(PollArg)

Returns the status of an asynchronous job for CopyBatchV2Async(RelocationBatchArgBase). It returns list of results for each entry.

Public methodCopyBatchV2Async(RelocationBatchArgBase)

Copy multiple files or folders to different locations at once in the user's Dropbox.

This route will replace CopyBatchAsync(RelocationBatchArg). The main difference is this route will return status for each entry, while CopyBatchAsync(RelocationBatchArg) raises failure if any entry fails.

This route will either finish synchronously, or return a job ID and do the async copy job in background. Please use CopyBatchCheckV2Async(PollArg) to check the job status.

Public methodCopyBatchV2Async(IEnumerableRelocationPath, Boolean)

Copy multiple files or folders to different locations at once in the user's Dropbox.

This route will replace CopyBatchAsync(RelocationBatchArg). The main difference is this route will return status for each entry, while CopyBatchAsync(RelocationBatchArg) raises failure if any entry fails.

This route will either finish synchronously, or return a job ID and do the async copy job in background. Please use CopyBatchCheckV2Async(PollArg) to check the job status.

Public methodCopyReferenceGetAsync(String)

Get a copy reference to a file or folder. This reference string can be used to save that file or folder to another user's Dropbox by passing it to CopyReferenceSaveAsync(SaveCopyReferenceArg).

Public methodCopyReferenceGetAsync(GetCopyReferenceArg)

Get a copy reference to a file or folder. This reference string can be used to save that file or folder to another user's Dropbox by passing it to CopyReferenceSaveAsync(SaveCopyReferenceArg).

Public methodCopyReferenceSaveAsync(SaveCopyReferenceArg)

Save a copy reference returned by CopyReferenceGetAsync(GetCopyReferenceArg) to the user's Dropbox.

Public methodCopyReferenceSaveAsync(String, String)

Save a copy reference returned by CopyReferenceGetAsync(GetCopyReferenceArg) to the user's Dropbox.

Public methodCopyV2Async(RelocationArg)

Copy a file or folder to a different location in the user's Dropbox.

If the source path is a folder all its contents will be copied.

Public methodCopyV2Async(String, String, Boolean, Boolean, Boolean)

Copy a file or folder to a different location in the user's Dropbox.

If the source path is a folder all its contents will be copied.

Public methodCreateFolderAsync(CreateFolderArg) Obsolete.

Create a folder at a given path.

Public methodCreateFolderAsync(String, Boolean) Obsolete.

Create a folder at a given path.

Public methodCreateFolderBatchAsync(CreateFolderBatchArg)

Create multiple folders at once.

This route is asynchronous for large batches, which returns a job ID immediately and runs the create folder batch asynchronously. Otherwise, creates the folders and returns the result synchronously for smaller inputs. You can force asynchronous behaviour by using the ForceAsync flag. Use CreateFolderBatchCheckAsync(PollArg) to check the job status.

Public methodCreateFolderBatchAsync(IEnumerableString, Boolean, Boolean)

Create multiple folders at once.

This route is asynchronous for large batches, which returns a job ID immediately and runs the create folder batch asynchronously. Otherwise, creates the folders and returns the result synchronously for smaller inputs. You can force asynchronous behaviour by using the ForceAsync flag. Use CreateFolderBatchCheckAsync(PollArg) to check the job status.

Public methodCreateFolderBatchCheckAsync(String)

Returns the status of an asynchronous job for CreateFolderBatchAsync(CreateFolderBatchArg). If success, it returns list of result for each entry.

Public methodCreateFolderBatchCheckAsync(PollArg)

Returns the status of an asynchronous job for CreateFolderBatchAsync(CreateFolderBatchArg). If success, it returns list of result for each entry.

Public methodCreateFolderV2Async(CreateFolderArg)

Create a folder at a given path.

Public methodCreateFolderV2Async(String, Boolean)

Create a folder at a given path.

Public methodDeleteAsync(DeleteArg) Obsolete.

Delete the file or folder at a given path.

If the path is a folder, all its contents will be deleted too.

A successful response indicates that the file or folder was deleted. The returned metadata will be the corresponding FileMetadata or FolderMetadata for the item at time of deletion, and not a DeletedMetadata object.

Public methodDeleteAsync(String, String) Obsolete.

Delete the file or folder at a given path.

If the path is a folder, all its contents will be deleted too.

A successful response indicates that the file or folder was deleted. The returned metadata will be the corresponding FileMetadata or FolderMetadata for the item at time of deletion, and not a DeletedMetadata object.

Public methodDeleteBatchAsync(IEnumerableDeleteArg)

Delete multiple files/folders at once.

This route is asynchronous, which returns a job ID immediately and runs the delete batch asynchronously. Use DeleteBatchCheckAsync(PollArg) to check the job status.

Public methodDeleteBatchAsync(DeleteBatchArg)

Delete multiple files/folders at once.

This route is asynchronous, which returns a job ID immediately and runs the delete batch asynchronously. Use DeleteBatchCheckAsync(PollArg) to check the job status.

Public methodDeleteBatchCheckAsync(String)

Returns the status of an asynchronous job for DeleteBatchAsync(DeleteBatchArg). If success, it returns list of result for each entry.

Public methodDeleteBatchCheckAsync(PollArg)

Returns the status of an asynchronous job for DeleteBatchAsync(DeleteBatchArg). If success, it returns list of result for each entry.

Public methodDeleteV2Async(DeleteArg)

Delete the file or folder at a given path.

If the path is a folder, all its contents will be deleted too.

A successful response indicates that the file or folder was deleted. The returned metadata will be the corresponding FileMetadata or FolderMetadata for the item at time of deletion, and not a DeletedMetadata object.

Public methodDeleteV2Async(String, String)

Delete the file or folder at a given path.

If the path is a folder, all its contents will be deleted too.

A successful response indicates that the file or folder was deleted. The returned metadata will be the corresponding FileMetadata or FolderMetadata for the item at time of deletion, and not a DeletedMetadata object.

Public methodDownloadAsync(DownloadArg)

Download a file from a user's Dropbox.

Public methodDownloadAsync(String, String)

Download a file from a user's Dropbox.

Public methodDownloadZipAsync(String)

Download a folder from the user's Dropbox, as a zip file. The folder must be less than 20 GB in size and have fewer than 10,000 total files. The input cannot be a single file. Any single file must be less than 4GB in size.

Public methodDownloadZipAsync(DownloadZipArg)

Download a folder from the user's Dropbox, as a zip file. The folder must be less than 20 GB in size and have fewer than 10,000 total files. The input cannot be a single file. Any single file must be less than 4GB in size.

Public methodEndAlphaGetMetadata Obsolete.

Waits for the pending asynchronous send to the alpha get metadata route to complete

Public methodEndAlphaUpload Obsolete.

Waits for the pending asynchronous send to the alpha upload route to complete

Public methodEndCopy Obsolete.

Waits for the pending asynchronous send to the copy route to complete

Public methodEndCopyBatch Obsolete.

Waits for the pending asynchronous send to the copy batch route to complete

Public methodEndCopyBatchCheck Obsolete.

Waits for the pending asynchronous send to the copy batch check route to complete

Public methodEndCopyBatchCheckV2

Waits for the pending asynchronous send to the copy batch check route to complete

Public methodEndCopyBatchV2

Waits for the pending asynchronous send to the copy batch route to complete

Public methodEndCopyReferenceGet

Waits for the pending asynchronous send to the copy reference get route to complete

Public methodEndCopyReferenceSave

Waits for the pending asynchronous send to the copy reference save route to complete

Public methodEndCopyV2

Waits for the pending asynchronous send to the copy route to complete

Public methodEndCreateFolder Obsolete.

Waits for the pending asynchronous send to the create folder route to complete

Public methodEndCreateFolderBatch

Waits for the pending asynchronous send to the create folder batch route to complete

Public methodEndCreateFolderBatchCheck

Waits for the pending asynchronous send to the create folder batch check route to complete

Public methodEndCreateFolderV2

Waits for the pending asynchronous send to the create folder route to complete

Public methodEndDelete Obsolete.

Waits for the pending asynchronous send to the delete route to complete

Public methodEndDeleteBatch

Waits for the pending asynchronous send to the delete batch route to complete

Public methodEndDeleteBatchCheck

Waits for the pending asynchronous send to the delete batch check route to complete

Public methodEndDeleteV2

Waits for the pending asynchronous send to the delete route to complete

Public methodEndDownload

Waits for the pending asynchronous send to the download route to complete

Public methodEndDownloadZip

Waits for the pending asynchronous send to the download zip route to complete

Public methodEndExport

Waits for the pending asynchronous send to the export route to complete

Public methodEndGetFileLockBatch

Waits for the pending asynchronous send to the get file lock batch route to complete

Public methodEndGetMetadata

Waits for the pending asynchronous send to the get metadata route to complete

Public methodEndGetPreview

Waits for the pending asynchronous send to the get preview route to complete

Public methodEndGetTemporaryLink

Waits for the pending asynchronous send to the get temporary link route to complete

Public methodEndGetTemporaryUploadLink

Waits for the pending asynchronous send to the get temporary upload link route to complete

Public methodEndGetThumbnail

Waits for the pending asynchronous send to the get thumbnail route to complete

Public methodEndGetThumbnailBatch

Waits for the pending asynchronous send to the get thumbnail batch route to complete

Public methodEndGetThumbnailV2

Waits for the pending asynchronous send to the get thumbnail route to complete

Public methodEndListFolder

Waits for the pending asynchronous send to the list folder route to complete

Public methodEndListFolderContinue

Waits for the pending asynchronous send to the list folder continue route to complete

Public methodEndListFolderGetLatestCursor

Waits for the pending asynchronous send to the list folder get latest cursor route to complete

Public methodEndListFolderLongpoll

Waits for the pending asynchronous send to the list folder longpoll route to complete

Public methodEndListRevisions

Waits for the pending asynchronous send to the list revisions route to complete

Public methodEndLockFileBatch

Waits for the pending asynchronous send to the lock file batch route to complete

Public methodEndMove Obsolete.

Waits for the pending asynchronous send to the move route to complete

Public methodEndMoveBatch Obsolete.

Waits for the pending asynchronous send to the move batch route to complete

Public methodEndMoveBatchCheck Obsolete.

Waits for the pending asynchronous send to the move batch check route to complete

Public methodEndMoveBatchCheckV2

Waits for the pending asynchronous send to the move batch check route to complete

Public methodEndMoveBatchV2

Waits for the pending asynchronous send to the move batch route to complete

Public methodEndMoveV2

Waits for the pending asynchronous send to the move route to complete

Public methodEndPermanentlyDelete

Waits for the pending asynchronous send to the permanently delete route to complete

Public methodEndPropertiesAdd Obsolete.

Waits for the pending asynchronous send to the properties add route to complete

Public methodEndPropertiesOverwrite Obsolete.

Waits for the pending asynchronous send to the properties overwrite route to complete

Public methodEndPropertiesRemove Obsolete.

Waits for the pending asynchronous send to the properties remove route to complete

Public methodEndPropertiesTemplateGet Obsolete.

Waits for the pending asynchronous send to the properties template get route to complete

Public methodEndPropertiesTemplateList Obsolete.

Waits for the pending asynchronous send to the properties template list route to complete

Public methodEndPropertiesUpdate Obsolete.

Waits for the pending asynchronous send to the properties update route to complete

Public methodEndRestore

Waits for the pending asynchronous send to the restore route to complete

Public methodEndSaveUrl

Waits for the pending asynchronous send to the save url route to complete

Public methodEndSaveUrlCheckJobStatus

Waits for the pending asynchronous send to the save url check job status route to complete

Public methodEndSearch Obsolete.

Waits for the pending asynchronous send to the search route to complete

Public methodEndSearchContinueV2

Waits for the pending asynchronous send to the search continue route to complete

Public methodEndSearchV2

Waits for the pending asynchronous send to the search route to complete

Public methodEndUnlockFileBatch

Waits for the pending asynchronous send to the unlock file batch route to complete

Public methodEndUpload

Waits for the pending asynchronous send to the upload route to complete

Public methodEndUploadSessionAppend Obsolete.

Waits for the pending asynchronous send to the upload session append route to complete

Public methodEndUploadSessionAppendV2

Waits for the pending asynchronous send to the upload session append route to complete

Public methodEndUploadSessionFinish

Waits for the pending asynchronous send to the upload session finish route to complete

Public methodEndUploadSessionFinishBatch

Waits for the pending asynchronous send to the upload session finish batch route to complete

Public methodEndUploadSessionFinishBatchCheck

Waits for the pending asynchronous send to the upload session finish batch check route to complete

Public methodEndUploadSessionStart

Waits for the pending asynchronous send to the upload session start route to complete

Public methodExportAsync(String)

Export a file from a user's Dropbox. This route only supports exporting files that cannot be downloaded directly and whose FileMetadata has ExportAs populated.

Public methodExportAsync(ExportArg)

Export a file from a user's Dropbox. This route only supports exporting files that cannot be downloaded directly and whose FileMetadata has ExportAs populated.

Public methodGetFileLockBatchAsync(IEnumerableLockFileArg)

Return the lock metadata for the given list of paths.

Public methodGetFileLockBatchAsync(LockFileBatchArg)

Return the lock metadata for the given list of paths.

Public methodGetMetadataAsync(GetMetadataArg)

Returns the metadata for a file or folder.

Note: Metadata for the root folder is unsupported.

Public methodGetMetadataAsync(String, Boolean, Boolean, Boolean, TemplateFilterBase)

Returns the metadata for a file or folder.

Note: Metadata for the root folder is unsupported.

Public methodGetPreviewAsync(PreviewArg)

Get a preview for a file.

Currently, PDF previews are generated for files with the following extensions: .ai, .doc, .docm, .docx, .eps, .gdoc, .gslides, .odp, .odt, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, .rtf.

HTML previews are generated for files with the following extensions: .csv, .ods, .xls, .xlsm, .gsheet, .xlsx.

Other formats will return an unsupported extension error.

Public methodGetPreviewAsync(String, String)

Get a preview for a file.

Currently, PDF previews are generated for files with the following extensions: .ai, .doc, .docm, .docx, .eps, .gdoc, .gslides, .odp, .odt, .pps, .ppsm, .ppsx, .ppt, .pptm, .pptx, .rtf.

HTML previews are generated for files with the following extensions: .csv, .ods, .xls, .xlsm, .gsheet, .xlsx.

Other formats will return an unsupported extension error.

Public methodGetTemporaryLinkAsync(String)

Get a temporary link to stream content of a file. This link will expire in four hours and afterwards you will get 410 Gone. This URL should not be used to display content directly in the browser. The Content-Type of the link is determined automatically by the file's mime type.

Public methodGetTemporaryLinkAsync(GetTemporaryLinkArg)

Get a temporary link to stream content of a file. This link will expire in four hours and afterwards you will get 410 Gone. This URL should not be used to display content directly in the browser. The Content-Type of the link is determined automatically by the file's mime type.

Public methodGetTemporaryUploadLinkAsync(GetTemporaryUploadLinkArg)

Get a one-time use temporary upload link to upload a file to a Dropbox location.

This endpoint acts as a delayed UploadAsync(CommitInfo, Stream). The returned temporary upload link may be used to make a POST request with the data to be uploaded. The upload will then be perfomed with the CommitInfo previously provided to GetTemporaryUploadLinkAsync(GetTemporaryUploadLinkArg) but evaluated only upon consumption. Hence, errors stemming from invalid CommitInfo with respect to the state of the user's Dropbox will only be communicated at consumption time. Additionally, these errors are surfaced as generic HTTP 409 Conflict responses, potentially hiding issue details. The maximum temporary upload link duration is 4 hours. Upon consumption or expiration, a new link will have to be generated. Multiple links may exist for a specific upload path at any given time.

The POST request on the temporary upload link must have its Content-Type set to "application/octet-stream".

Example temporary upload link consumption request:

curl -X POST https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND

--header "Content-Type: application/octet-stream"

--data-binary @local_file.txt

A successful temporary upload link consumption request returns the content hash of the uploaded data in JSON format.

Example succesful temporary upload link consumption response:

{"content-hash": "599d71033d700ac892a0e48fa61b125d2f5994"}

An unsuccessful temporary upload link consumption request returns any of the following status codes:

HTTP 400 Bad Request: Content-Type is not one of application/octet-stream and text/plain or request is invalid.

HTTP 409 Conflict: The temporary upload link does not exist or is currently unavailable, the upload failed, or another error happened.

HTTP 410 Gone: The temporary upload link is expired or consumed.

Example unsuccessful temporary upload link consumption response:

Temporary upload link has been recently consumed.

Public methodGetTemporaryUploadLinkAsync(CommitInfo, Double)

Get a one-time use temporary upload link to upload a file to a Dropbox location.

This endpoint acts as a delayed UploadAsync(CommitInfo, Stream). The returned temporary upload link may be used to make a POST request with the data to be uploaded. The upload will then be perfomed with the CommitInfo previously provided to GetTemporaryUploadLinkAsync(GetTemporaryUploadLinkArg) but evaluated only upon consumption. Hence, errors stemming from invalid CommitInfo with respect to the state of the user's Dropbox will only be communicated at consumption time. Additionally, these errors are surfaced as generic HTTP 409 Conflict responses, potentially hiding issue details. The maximum temporary upload link duration is 4 hours. Upon consumption or expiration, a new link will have to be generated. Multiple links may exist for a specific upload path at any given time.

The POST request on the temporary upload link must have its Content-Type set to "application/octet-stream".

Example temporary upload link consumption request:

curl -X POST https://content.dropboxapi.com/apitul/1/bNi2uIYF51cVBND

--header "Content-Type: application/octet-stream"

--data-binary @local_file.txt

A successful temporary upload link consumption request returns the content hash of the uploaded data in JSON format.

Example succesful temporary upload link consumption response:

{"content-hash": "599d71033d700ac892a0e48fa61b125d2f5994"}

An unsuccessful temporary upload link consumption request returns any of the following status codes:

HTTP 400 Bad Request: Content-Type is not one of application/octet-stream and text/plain or request is invalid.

HTTP 409 Conflict: The temporary upload link does not exist or is currently unavailable, the upload failed, or another error happened.

HTTP 410 Gone: The temporary upload link is expired or consumed.

Example unsuccessful temporary upload link consumption response:

Temporary upload link has been recently consumed.

Public methodGetThumbnailAsync(ThumbnailArg)

Get a thumbnail for an image.

This method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail.

Public methodGetThumbnailAsync(String, ThumbnailFormat, ThumbnailSize, ThumbnailMode)

Get a thumbnail for an image.

This method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail.

Public methodGetThumbnailBatchAsync(GetThumbnailBatchArg)

Get thumbnails for a list of images. We allow up to 25 thumbnails in a single batch.

This method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail.

Public methodGetThumbnailBatchAsync(IEnumerableThumbnailArg)

Get thumbnails for a list of images. We allow up to 25 thumbnails in a single batch.

This method currently supports files with the following file extensions: jpg, jpeg, png, tiff, tif, gif and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail.

Public methodGetThumbnailV2Async(ThumbnailV2Arg)

Get a thumbnail for a file.

Public methodGetThumbnailV2Async(PathOrLink, ThumbnailFormat, ThumbnailSize, ThumbnailMode)

Get a thumbnail for a file.

Public methodListFolderAsync(ListFolderArg)

Starts returning the contents of a folder. If the result's HasMore field is true, call ListFolderContinueAsync(ListFolderContinueArg) with the returned Cursor to retrieve more entries.

If you're using Recursive set to true to keep a local cache of the contents of a Dropbox account, iterate through each entry in order and process them as follows to keep your local state in sync:

For each FileMetadata, store the new entry at the given path in your local state. If the required parent folders don't exist yet, create them. If there's already something else at the given path, replace it and remove all its children.

For each FolderMetadata, store the new entry at the given path in your local state. If the required parent folders don't exist yet, create them. If there's already something else at the given path, replace it but leave the children as they are. Check the new entry's [!:Dropbox.Api.Files.FolderSharingInfo.ReadOnly] and set all its children's read-only statuses to match.

For each DeletedMetadata, if your local state has something at the given path, remove it and all its children. If there's nothing at the given path, ignore this entry.

Note: RateLimitError may be returned if multiple ListFolderAsync(ListFolderArg) or ListFolderContinueAsync(ListFolderContinueArg) calls with same parameters are made simultaneously by same API app for same user. If your app implements retry logic, please hold off the retry until the previous request finishes.

Public methodListFolderAsync(String, Boolean, Boolean, Boolean, Boolean, Boolean, NullableUInt32, SharedLink, TemplateFilterBase, Boolean)

Starts returning the contents of a folder. If the result's HasMore field is true, call ListFolderContinueAsync(ListFolderContinueArg) with the returned Cursor to retrieve more entries.

If you're using Recursive set to true to keep a local cache of the contents of a Dropbox account, iterate through each entry in order and process them as follows to keep your local state in sync:

For each FileMetadata, store the new entry at the given path in your local state. If the required parent folders don't exist yet, create them. If there's already something else at the given path, replace it and remove all its children.

For each FolderMetadata, store the new entry at the given path in your local state. If the required parent folders don't exist yet, create them. If there's already something else at the given path, replace it but leave the children as they are. Check the new entry's [!:Dropbox.Api.Files.FolderSharingInfo.ReadOnly] and set all its children's read-only statuses to match.

For each DeletedMetadata, if your local state has something at the given path, remove it and all its children. If there's nothing at the given path, ignore this entry.

Note: RateLimitError may be returned if multiple ListFolderAsync(ListFolderArg) or ListFolderContinueAsync(ListFolderContinueArg) calls with same parameters are made simultaneously by same API app for same user. If your app implements retry logic, please hold off the retry until the previous request finishes.

Public methodListFolderContinueAsync(String)

Once a cursor has been retrieved from ListFolderAsync(ListFolderArg), use this to paginate through all files and retrieve updates to the folder, following the same rules as documented for ListFolderAsync(ListFolderArg).

Public methodListFolderContinueAsync(ListFolderContinueArg)

Once a cursor has been retrieved from ListFolderAsync(ListFolderArg), use this to paginate through all files and retrieve updates to the folder, following the same rules as documented for ListFolderAsync(ListFolderArg).

Public methodListFolderGetLatestCursorAsync(ListFolderArg)

A way to quickly get a cursor for the folder's state. Unlike ListFolderAsync(ListFolderArg), ListFolderGetLatestCursorAsync(ListFolderArg) doesn't return any entries. This endpoint is for app which only needs to know about new files and modifications and doesn't need to know about files that already exist in Dropbox.

Public methodListFolderGetLatestCursorAsync(String, Boolean, Boolean, Boolean, Boolean, Boolean, NullableUInt32, SharedLink, TemplateFilterBase, Boolean)

A way to quickly get a cursor for the folder's state. Unlike ListFolderAsync(ListFolderArg), ListFolderGetLatestCursorAsync(ListFolderArg) doesn't return any entries. This endpoint is for app which only needs to know about new files and modifications and doesn't need to know about files that already exist in Dropbox.

Public methodListFolderLongpollAsync(ListFolderLongpollArg)

A longpoll endpoint to wait for changes on an account. In conjunction with ListFolderContinueAsync(ListFolderContinueArg), this call gives you a low-latency way to monitor an account for file changes. The connection will block until there are changes available or a timeout occurs. This endpoint is useful mostly for client-side apps. If you're looking for server-side notifications, check out our webhooks documentation.

Public methodListFolderLongpollAsync(String, UInt64)

A longpoll endpoint to wait for changes on an account. In conjunction with ListFolderContinueAsync(ListFolderContinueArg), this call gives you a low-latency way to monitor an account for file changes. The connection will block until there are changes available or a timeout occurs. This endpoint is useful mostly for client-side apps. If you're looking for server-side notifications, check out our webhooks documentation.

Public methodListRevisionsAsync(ListRevisionsArg)

Returns revisions for files based on a file path or a file id. The file path or file id is identified from the latest file entry at the given file path or id. This end point allows your app to query either by file path or file id by setting the mode parameter appropriately.

In the ListRevisionsModePath (default) mode, all revisions at the same file path as the latest file entry are returned. If revisions with the same file id are desired, then mode must be set to ListRevisionsModeId. The ListRevisionsModeId mode is useful to retrieve revisions for a given file across moves or renames.

Public methodListRevisionsAsync(String, ListRevisionsMode, UInt64)

Returns revisions for files based on a file path or a file id. The file path or file id is identified from the latest file entry at the given file path or id. This end point allows your app to query either by file path or file id by setting the mode parameter appropriately.

In the ListRevisionsModePath (default) mode, all revisions at the same file path as the latest file entry are returned. If revisions with the same file id are desired, then mode must be set to ListRevisionsModeId. The ListRevisionsModeId mode is useful to retrieve revisions for a given file across moves or renames.

Public methodLockFileBatchAsync(IEnumerableLockFileArg)

Lock the files at the given paths. A locked file will be writable only by the lock holder. A successful response indicates that the file has been locked. Returns a list of the locked file paths and their metadata after this operation.

Public methodLockFileBatchAsync(LockFileBatchArg)

Lock the files at the given paths. A locked file will be writable only by the lock holder. A successful response indicates that the file has been locked. Returns a list of the locked file paths and their metadata after this operation.

Public methodMoveAsync(RelocationArg) Obsolete.

Move a file or folder to a different location in the user's Dropbox.

If the source path is a folder all its contents will be moved.

Public methodMoveAsync(String, String, Boolean, Boolean, Boolean) Obsolete.

Move a file or folder to a different location in the user's Dropbox.

If the source path is a folder all its contents will be moved.

Public methodMoveBatchAsync(RelocationBatchArg) Obsolete.

Move multiple files or folders to different locations at once in the user's Dropbox.

This route will return job ID immediately and do the async moving job in background. Please use MoveBatchCheckAsync(PollArg) to check the job status.

Public methodMoveBatchAsync(IEnumerableRelocationPath, Boolean, Boolean, Boolean) Obsolete.

Move multiple files or folders to different locations at once in the user's Dropbox.

This route will return job ID immediately and do the async moving job in background. Please use MoveBatchCheckAsync(PollArg) to check the job status.

Public methodMoveBatchCheckAsync(String) Obsolete.

Returns the status of an asynchronous job for MoveBatchAsync(RelocationBatchArg). If success, it returns list of results for each entry.

Public methodMoveBatchCheckAsync(PollArg) Obsolete.

Returns the status of an asynchronous job for MoveBatchAsync(RelocationBatchArg). If success, it returns list of results for each entry.

Public methodMoveBatchCheckV2Async(String)

Returns the status of an asynchronous job for MoveBatchV2Async(MoveBatchArg). It returns list of results for each entry.

Public methodMoveBatchCheckV2Async(PollArg)

Returns the status of an asynchronous job for MoveBatchV2Async(MoveBatchArg). It returns list of results for each entry.

Public methodMoveBatchV2Async(MoveBatchArg)

Move multiple files or folders to different locations at once in the user's Dropbox. Note that we do not currently support case-only renaming.

This route will replace MoveBatchAsync(RelocationBatchArg). The main difference is this route will return status for each entry, while MoveBatchAsync(RelocationBatchArg) raises failure if any entry fails.

This route will either finish synchronously, or return a job ID and do the async move job in background. Please use MoveBatchCheckV2Async(PollArg) to check the job status.

Public methodMoveBatchV2Async(IEnumerableRelocationPath, Boolean, Boolean)

Move multiple files or folders to different locations at once in the user's Dropbox. Note that we do not currently support case-only renaming.

This route will replace MoveBatchAsync(RelocationBatchArg). The main difference is this route will return status for each entry, while MoveBatchAsync(RelocationBatchArg) raises failure if any entry fails.

This route will either finish synchronously, or return a job ID and do the async move job in background. Please use MoveBatchCheckV2Async(PollArg) to check the job status.

Public methodMoveV2Async(RelocationArg)

Move a file or folder to a different location in the user's Dropbox.

If the source path is a folder all its contents will be moved.

Note that we do not currently support case-only renaming.

Public methodMoveV2Async(String, String, Boolean, Boolean, Boolean)

Move a file or folder to a different location in the user's Dropbox.

If the source path is a folder all its contents will be moved.

Note that we do not currently support case-only renaming.

Public methodPermanentlyDeleteAsync(DeleteArg)

Permanently delete the file or folder at a given path (see https://www.dropbox.com/en/help/40).

Note: This endpoint is only available for Dropbox Business apps.

Public methodPermanentlyDeleteAsync(String, String)

Permanently delete the file or folder at a given path (see https://www.dropbox.com/en/help/40).

Note: This endpoint is only available for Dropbox Business apps.

Public methodPropertiesAddAsync(AddPropertiesArg) Obsolete.

The properties add route

Public methodPropertiesAddAsync(String, IEnumerablePropertyGroup) Obsolete.

The properties add route

Public methodPropertiesOverwriteAsync(OverwritePropertyGroupArg) Obsolete.

The properties overwrite route

Public methodPropertiesOverwriteAsync(String, IEnumerablePropertyGroup) Obsolete.

The properties overwrite route

Public methodPropertiesRemoveAsync(RemovePropertiesArg) Obsolete.

The properties remove route

Public methodPropertiesRemoveAsync(String, IEnumerableString) Obsolete.

The properties remove route

Public methodPropertiesTemplateGetAsync(String) Obsolete.

The properties template get route

Public methodPropertiesTemplateGetAsync(GetTemplateArg) Obsolete.

The properties template get route

Public methodPropertiesTemplateListAsync Obsolete.

The properties template list route

Public methodPropertiesUpdateAsync(UpdatePropertiesArg) Obsolete.

The properties update route

Public methodPropertiesUpdateAsync(String, IEnumerablePropertyGroupUpdate) Obsolete.

The properties update route

Public methodRestoreAsync(RestoreArg)

Restore a specific revision of a file to the given path.

Public methodRestoreAsync(String, String)

Restore a specific revision of a file to the given path.

Public methodSaveUrlAsync(SaveUrlArg)

Save the data from a specified URL into a file in user's Dropbox.

Note that the transfer from the URL must complete within 5 minutes, or the operation will time out and the job will fail.

If the given path already exists, the file will be renamed to avoid the conflict (e.g. myfile (1).txt).

Public methodSaveUrlAsync(String, String)

Save the data from a specified URL into a file in user's Dropbox.

Note that the transfer from the URL must complete within 5 minutes, or the operation will time out and the job will fail.

If the given path already exists, the file will be renamed to avoid the conflict (e.g. myfile (1).txt).

Public methodSaveUrlCheckJobStatusAsync(String)

Check the status of a SaveUrlAsync(SaveUrlArg) job.

Public methodSaveUrlCheckJobStatusAsync(PollArg)

Check the status of a SaveUrlAsync(SaveUrlArg) job.

Public methodSearchAsync(SearchArg) Obsolete.

Searches for files and folders.

Note: Recent changes will be reflected in search results within a few seconds and older revisions of existing files may still match your query for up to a few days.

Public methodSearchAsync(String, String, UInt64, UInt64, SearchMode) Obsolete.

Searches for files and folders.

Note: Recent changes will be reflected in search results within a few seconds and older revisions of existing files may still match your query for up to a few days.

Public methodSearchContinueV2Async(String)

Fetches the next page of search results returned from SearchV2Async(SearchV2Arg).

Note: SearchV2Async(SearchV2Arg) along with SearchContinueV2Async(SearchV2ContinueArg) can only be used to retrieve a maximum of 10,000 matches.

Recent changes may not immediately be reflected in search results due to a short delay in indexing. Duplicate results may be returned across pages. Some results may not be returned.

Public methodSearchContinueV2Async(SearchV2ContinueArg)

Fetches the next page of search results returned from SearchV2Async(SearchV2Arg).

Note: SearchV2Async(SearchV2Arg) along with SearchContinueV2Async(SearchV2ContinueArg) can only be used to retrieve a maximum of 10,000 matches.

Recent changes may not immediately be reflected in search results due to a short delay in indexing. Duplicate results may be returned across pages. Some results may not be returned.

Public methodSearchV2Async(SearchV2Arg)

Searches for files and folders.

Note: SearchV2Async(SearchV2Arg) along with SearchContinueV2Async(SearchV2ContinueArg) can only be used to retrieve a maximum of 10,000 matches.

Recent changes may not immediately be reflected in search results due to a short delay in indexing. Duplicate results may be returned across pages. Some results may not be returned.

Public methodSearchV2Async(String, SearchOptions, SearchMatchFieldOptions, Boolean)

Searches for files and folders.

Note: SearchV2Async(SearchV2Arg) along with SearchContinueV2Async(SearchV2ContinueArg) can only be used to retrieve a maximum of 10,000 matches.

Recent changes may not immediately be reflected in search results due to a short delay in indexing. Duplicate results may be returned across pages. Some results may not be returned.

Public methodUnlockFileBatchAsync(IEnumerableUnlockFileArg)

Unlock the files at the given paths. A locked file can only be unlocked by the lock holder or, if a business account, a team admin. A successful response indicates that the file has been unlocked. Returns a list of the unlocked file paths and their metadata after this operation.

Public methodUnlockFileBatchAsync(UnlockFileBatchArg)

Unlock the files at the given paths. A locked file can only be unlocked by the lock holder or, if a business account, a team admin. A successful response indicates that the file has been unlocked. Returns a list of the unlocked file paths and their metadata after this operation.

Public methodUploadAsync(CommitInfo, Stream)

Create a new file with the contents provided in the request.

Do not use this to upload a file larger than 150 MB. Instead, create an upload session with UploadSessionStartAsync(UploadSessionStartArg, Stream).

Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page.

Public methodUploadAsync(String, WriteMode, Boolean, NullableDateTime, Boolean, IEnumerablePropertyGroup, Boolean, Stream)

Create a new file with the contents provided in the request.

Do not use this to upload a file larger than 150 MB. Instead, create an upload session with UploadSessionStartAsync(UploadSessionStartArg, Stream).

Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page.

Public methodUploadSessionAppendAsync(UploadSessionCursor, Stream) Obsolete.

Append more data to an upload session.

A single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.

Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page.

Public methodUploadSessionAppendAsync(String, UInt64, Stream) Obsolete.

Append more data to an upload session.

A single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.

Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page.

Public methodUploadSessionAppendV2Async(UploadSessionAppendArg, Stream)

Append more data to an upload session.

When the parameter close is set, this call will close the session.

A single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.

Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page.

Public methodUploadSessionAppendV2Async(UploadSessionCursor, Boolean, Stream)

Append more data to an upload session.

When the parameter close is set, this call will close the session.

A single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.

Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page.

Public methodUploadSessionFinishAsync(UploadSessionFinishArg, Stream)

Finish an upload session and save the uploaded data to the given file path.

A single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.

Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page.

Public methodUploadSessionFinishAsync(UploadSessionCursor, CommitInfo, Stream)

Finish an upload session and save the uploaded data to the given file path.

A single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.

Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page.

Public methodUploadSessionFinishBatchAsync(IEnumerableUploadSessionFinishArg)

This route helps you commit many files at once into a user's Dropbox. Use UploadSessionStartAsync(UploadSessionStartArg, Stream) and UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) to upload file contents. We recommend uploading many files in parallel to increase throughput. Once the file contents have been uploaded, rather than calling UploadSessionFinishAsync(UploadSessionFinishArg, Stream), use this route to finish all your upload sessions in a single request.

Close or Close needs to be true for the last UploadSessionStartAsync(UploadSessionStartArg, Stream) or UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) call. The maximum size of a file one can upload to an upload session is 350 GB.

This route will return a job_id immediately and do the async commit job in background. Use UploadSessionFinishBatchCheckAsync(PollArg) to check the job status.

For the same account, this route should be executed serially. That means you should not start the next job before current job finishes. We allow up to 1000 entries in a single request.

Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page.

Public methodUploadSessionFinishBatchAsync(UploadSessionFinishBatchArg)

This route helps you commit many files at once into a user's Dropbox. Use UploadSessionStartAsync(UploadSessionStartArg, Stream) and UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) to upload file contents. We recommend uploading many files in parallel to increase throughput. Once the file contents have been uploaded, rather than calling UploadSessionFinishAsync(UploadSessionFinishArg, Stream), use this route to finish all your upload sessions in a single request.

Close or Close needs to be true for the last UploadSessionStartAsync(UploadSessionStartArg, Stream) or UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) call. The maximum size of a file one can upload to an upload session is 350 GB.

This route will return a job_id immediately and do the async commit job in background. Use UploadSessionFinishBatchCheckAsync(PollArg) to check the job status.

For the same account, this route should be executed serially. That means you should not start the next job before current job finishes. We allow up to 1000 entries in a single request.

Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page.

Public methodUploadSessionFinishBatchCheckAsync(String)

Returns the status of an asynchronous job for UploadSessionFinishBatchAsync(UploadSessionFinishBatchArg). If success, it returns list of result for each entry.

Public methodUploadSessionFinishBatchCheckAsync(PollArg)

Returns the status of an asynchronous job for UploadSessionFinishBatchAsync(UploadSessionFinishBatchArg). If success, it returns list of result for each entry.

Public methodUploadSessionStartAsync(Boolean, Stream)

Upload sessions allow you to upload a single file in one or more requests, for example where the size of the file is greater than 150 MB. This call starts a new upload session with the given data. You can then use UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) to add more data and UploadSessionFinishAsync(UploadSessionFinishArg, Stream) to save all the data to a file in Dropbox.

A single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.

An upload session can be used for a maximum of 48 hours. Attempting to use an SessionId with UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) or UploadSessionFinishAsync(UploadSessionFinishArg, Stream) more than 48 hours after its creation will return a UploadSessionLookupErrorNotFound.

Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page.

Public methodUploadSessionStartAsync(UploadSessionStartArg, Stream)

Upload sessions allow you to upload a single file in one or more requests, for example where the size of the file is greater than 150 MB. This call starts a new upload session with the given data. You can then use UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) to add more data and UploadSessionFinishAsync(UploadSessionFinishArg, Stream) to save all the data to a file in Dropbox.

A single request should not upload more than 150 MB. The maximum size of a file one can upload to an upload session is 350 GB.

An upload session can be used for a maximum of 48 hours. Attempting to use an SessionId with UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) or UploadSessionFinishAsync(UploadSessionFinishArg, Stream) more than 48 hours after its creation will return a UploadSessionLookupErrorNotFound.

Calls to this endpoint will count as data transport calls for any Dropbox Business teams with a limit on the number of data transport calls allowed per month. For more information, see the Data transport limit page.

Top
See Also