Class FilesUserRoutes

The routes for the Dropbox.Api.Files namespace

Inheritance

System.Object

FilesUserRoutes

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Dropbox.Api.Files.Routes

Assembly: Dropbox.Api.dll

Syntax

public class FilesUserRoutes

Methods

AlphaGetMetadataAsync(AlphaGetMetadataArg)

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.

Declaration

[Obsolete("This function is deprecated, please use GetMetadataAsync instead.")]
public Task<Metadata> AlphaGetMetadataAsync(AlphaGetMetadataArg alphaGetMetadataArg)

Parameters

Type	Name	Description
AlphaGetMetadataArg	alphaGetMetadataArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<Metadata>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a AlphaGetMetadataError.

AlphaGetMetadataAsync(String, Boolean, Boolean, Boolean, TemplateFilterBase, IEnumerable<String>)

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.

Declaration

[Obsolete("This function is deprecated, please use GetMetadataAsync instead.")]
public Task<Metadata> AlphaGetMetadataAsync(string path, bool includeMediaInfo = false, bool includeDeleted = false, bool includeHasExplicitSharedMembers = false, TemplateFilterBase includePropertyGroups = null, IEnumerable<string> includePropertyTemplates = null)

Parameters

Type	Name	Description
System.String	path	The path of a file or folder on Dropbox.
System.Boolean	includeMediaInfo	If true, MediaInfo is set for photo and video.
System.Boolean	includeDeleted	If true, DeletedMetadata will be returned for deleted file or folder, otherwise LookupError.NotFound will be returned.
System.Boolean	includeHasExplicitSharedMembers	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
TemplateFilterBase	includePropertyGroups	If set to a valid list of template IDs, PropertyGroups is set if there exists property data associated with the file and each of the listed templates.
System.Collections.Generic.IEnumerable<System.String>	includePropertyTemplates	If set to a valid list of template IDs, PropertyGroups is set for files with custom properties.

Returns

Type	Description
System.Threading.Tasks.Task<Metadata>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a AlphaGetMetadataError.

AlphaUploadAsync(UploadArg, Stream)

Create a new file with the contents provided in the request. Note that the behavior of this alpha endpoint is unstable and subject to change.

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

Declaration

[Obsolete("This function is deprecated, please use UploadAsync instead.")]
public Task<FileMetadata> AlphaUploadAsync(UploadArg uploadArg, Stream body)

Parameters

Type	Name	Description
UploadArg	uploadArg	The request parameters
System.IO.Stream	body	The content to upload.

Returns

Type	Description
System.Threading.Tasks.Task<FileMetadata>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UploadError.

AlphaUploadAsync(String, WriteMode, Boolean, Nullable<DateTime>, Boolean, IEnumerable<PropertyGroup>, Boolean, String, Stream)

Create a new file with the contents provided in the request. Note that the behavior of this alpha endpoint is unstable and subject to change.

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

Declaration

[Obsolete("This function is deprecated, please use UploadAsync instead.")]
public Task<FileMetadata> AlphaUploadAsync(string path, WriteMode mode = null, bool autorename = false, DateTime? clientModified = null, bool mute = false, IEnumerable<PropertyGroup> propertyGroups = null, bool strictConflict = false, string contentHash = null, Stream body = null)

Parameters

Type	Name	Description
System.String	path	Path in the user's Dropbox to save the file.
WriteMode	mode	Selects what to do if the file already exists.
System.Boolean	autorename	If there's a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict.
System.Nullable<System.DateTime>	clientModified	The value to store as the clientModified timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified.
System.Boolean	mute	Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If true, this tells the clients that this modification shouldn't result in a user notification.
System.Collections.Generic.IEnumerable<PropertyGroup>	propertyGroups	List of custom properties to add to file.
System.Boolean	strictConflict	Be more strict about how each WriteMode detects conflict. For example, always return a conflict error when mode = WriteMode.Update and the given "rev" doesn't match the existing file's "rev", even if the existing file has been deleted. This also forces a conflict even when the target path refers to a file with identical contents.
System.String	contentHash	A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash page.
System.IO.Stream	body	The document to upload

Returns

Type	Description
System.Threading.Tasks.Task<FileMetadata>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UploadError.

BeginAlphaGetMetadata(AlphaGetMetadataArg, AsyncCallback, Object)

Begins an asynchronous send to the alpha get metadata route.

Declaration

[Obsolete("This function is deprecated, please use BeginGetMetadata instead.")]
public IAsyncResult BeginAlphaGetMetadata(AlphaGetMetadataArg alphaGetMetadataArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
AlphaGetMetadataArg	alphaGetMetadataArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginAlphaGetMetadata(String, Boolean, Boolean, Boolean, TemplateFilterBase, IEnumerable<String>, AsyncCallback, Object)

Begins an asynchronous send to the alpha get metadata route.

Declaration

[Obsolete("This function is deprecated, please use BeginGetMetadata instead.")]
public IAsyncResult BeginAlphaGetMetadata(string path, bool includeMediaInfo = false, bool includeDeleted = false, bool includeHasExplicitSharedMembers = false, TemplateFilterBase includePropertyGroups = null, IEnumerable<string> includePropertyTemplates = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	The path of a file or folder on Dropbox.
System.Boolean	includeMediaInfo	If true, MediaInfo is set for photo and video.
System.Boolean	includeDeleted	If true, DeletedMetadata will be returned for deleted file or folder, otherwise LookupError.NotFound will be returned.
System.Boolean	includeHasExplicitSharedMembers	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
TemplateFilterBase	includePropertyGroups	If set to a valid list of template IDs, PropertyGroups is set if there exists property data associated with the file and each of the listed templates.
System.Collections.Generic.IEnumerable<System.String>	includePropertyTemplates	If set to a valid list of template IDs, PropertyGroups is set for files with custom properties.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginAlphaUpload(UploadArg, Stream, AsyncCallback, Object)

Begins an asynchronous send to the alpha upload route.

Declaration

[Obsolete("This function is deprecated, please use BeginUpload instead.")]
public IAsyncResult BeginAlphaUpload(UploadArg uploadArg, Stream body, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UploadArg	uploadArg	The request parameters.
System.IO.Stream	body	The content to upload.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginAlphaUpload(String, WriteMode, Boolean, Nullable<DateTime>, Boolean, IEnumerable<PropertyGroup>, Boolean, String, Stream, AsyncCallback, Object)

Begins an asynchronous send to the alpha upload route.

Declaration

[Obsolete("This function is deprecated, please use BeginUpload instead.")]
public IAsyncResult BeginAlphaUpload(string path, WriteMode mode = null, bool autorename = false, DateTime? clientModified = null, bool mute = false, IEnumerable<PropertyGroup> propertyGroups = null, bool strictConflict = false, string contentHash = null, Stream body = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	Path in the user's Dropbox to save the file.
WriteMode	mode	Selects what to do if the file already exists.
System.Boolean	autorename	If there's a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict.
System.Nullable<System.DateTime>	clientModified	The value to store as the clientModified timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified.
System.Boolean	mute	Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If true, this tells the clients that this modification shouldn't result in a user notification.
System.Collections.Generic.IEnumerable<PropertyGroup>	propertyGroups	List of custom properties to add to file.
System.Boolean	strictConflict	Be more strict about how each WriteMode detects conflict. For example, always return a conflict error when mode = WriteMode.Update and the given "rev" doesn't match the existing file's "rev", even if the existing file has been deleted. This also forces a conflict even when the target path refers to a file with identical contents.
System.String	contentHash	A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash page.
System.IO.Stream	body	The document to upload
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCopy(RelocationArg, AsyncCallback, Object)

Begins an asynchronous send to the copy route.

Declaration

[Obsolete("This function is deprecated, please use BeginCopyV2 instead.")]
public IAsyncResult BeginCopy(RelocationArg relocationArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RelocationArg	relocationArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCopy(String, String, Boolean, Boolean, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the copy route.

Declaration

[Obsolete("This function is deprecated, please use BeginCopyV2 instead.")]
public IAsyncResult BeginCopy(string fromPath, string toPath, bool allowSharedFolder = false, bool autorename = false, bool allowOwnershipTransfer = false, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	fromPath	Path in the user's Dropbox to be copied or moved.
System.String	toPath	Path in the user's Dropbox that is the destination.
System.Boolean	allowSharedFolder	This flag has no effect.
System.Boolean	autorename	If there's a conflict, have the Dropbox server try to autorename the file to avoid the conflict.
System.Boolean	allowOwnershipTransfer	Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCopyBatch(RelocationBatchArg, AsyncCallback, Object)

Begins an asynchronous send to the copy batch route.

Declaration

[Obsolete("This function is deprecated, please use BeginCopyBatchV2 instead.")]
public IAsyncResult BeginCopyBatch(RelocationBatchArg relocationBatchArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RelocationBatchArg	relocationBatchArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCopyBatch(IEnumerable<RelocationPath>, Boolean, Boolean, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the copy batch route.

Declaration

[Obsolete("This function is deprecated, please use BeginCopyBatchV2 instead.")]
public IAsyncResult BeginCopyBatch(IEnumerable<RelocationPath> entries, bool autorename = false, bool allowSharedFolder = false, bool allowOwnershipTransfer = false, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<RelocationPath>	entries	List of entries to be moved or copied. Each entry is RelocationPath.
System.Boolean	autorename	If there's a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict.
System.Boolean	allowSharedFolder	This flag has no effect.
System.Boolean	allowOwnershipTransfer	Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCopyBatchCheck(PollArg, AsyncCallback, Object)

Begins an asynchronous send to the copy batch check route.

Declaration

[Obsolete("This function is deprecated, please use BeginCopyBatchCheckV2 instead.")]
public IAsyncResult BeginCopyBatchCheck(PollArg pollArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCopyBatchCheck(String, AsyncCallback, Object)

Begins an asynchronous send to the copy batch check route.

Declaration

[Obsolete("This function is deprecated, please use BeginCopyBatchCheckV2 instead.")]
public IAsyncResult BeginCopyBatchCheck(string asyncJobId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCopyBatchCheckV2(PollArg, AsyncCallback, Object)

Begins an asynchronous send to the copy batch check route.

Declaration

public IAsyncResult BeginCopyBatchCheckV2(PollArg pollArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCopyBatchCheckV2(String, AsyncCallback, Object)

Begins an asynchronous send to the copy batch check route.

Declaration

public IAsyncResult BeginCopyBatchCheckV2(string asyncJobId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCopyBatchV2(RelocationBatchArgBase, AsyncCallback, Object)

Begins an asynchronous send to the copy batch route.

Declaration

public IAsyncResult BeginCopyBatchV2(RelocationBatchArgBase relocationBatchArgBase, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RelocationBatchArgBase	relocationBatchArgBase	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCopyBatchV2(IEnumerable<RelocationPath>, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the copy batch route.

Declaration

public IAsyncResult BeginCopyBatchV2(IEnumerable<RelocationPath> entries, bool autorename = false, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<RelocationPath>	entries	List of entries to be moved or copied. Each entry is RelocationPath.
System.Boolean	autorename	If there's a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCopyReferenceGet(GetCopyReferenceArg, AsyncCallback, Object)

Begins an asynchronous send to the copy reference get route.

Declaration

public IAsyncResult BeginCopyReferenceGet(GetCopyReferenceArg getCopyReferenceArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetCopyReferenceArg	getCopyReferenceArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCopyReferenceGet(String, AsyncCallback, Object)

Begins an asynchronous send to the copy reference get route.

Declaration

public IAsyncResult BeginCopyReferenceGet(string path, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	The path to the file or folder you want to get a copy reference to.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCopyReferenceSave(SaveCopyReferenceArg, AsyncCallback, Object)

Begins an asynchronous send to the copy reference save route.

Declaration

public IAsyncResult BeginCopyReferenceSave(SaveCopyReferenceArg saveCopyReferenceArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
SaveCopyReferenceArg	saveCopyReferenceArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCopyReferenceSave(String, String, AsyncCallback, Object)

Begins an asynchronous send to the copy reference save route.

Declaration

public IAsyncResult BeginCopyReferenceSave(string copyReference, string path, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	copyReference	A copy reference returned by CopyReferenceGetAsync(GetCopyReferenceArg).
System.String	path	Path in the user's Dropbox that is the destination.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCopyV2(RelocationArg, AsyncCallback, Object)

Begins an asynchronous send to the copy route.

Declaration

public IAsyncResult BeginCopyV2(RelocationArg relocationArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RelocationArg	relocationArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCopyV2(String, String, Boolean, Boolean, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the copy route.

Declaration

public IAsyncResult BeginCopyV2(string fromPath, string toPath, bool allowSharedFolder = false, bool autorename = false, bool allowOwnershipTransfer = false, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	fromPath	Path in the user's Dropbox to be copied or moved.
System.String	toPath	Path in the user's Dropbox that is the destination.
System.Boolean	allowSharedFolder	This flag has no effect.
System.Boolean	autorename	If there's a conflict, have the Dropbox server try to autorename the file to avoid the conflict.
System.Boolean	allowOwnershipTransfer	Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCreateFolder(CreateFolderArg, AsyncCallback, Object)

Begins an asynchronous send to the create folder route.

Declaration

[Obsolete("This function is deprecated, please use BeginCreateFolderV2 instead.")]
public IAsyncResult BeginCreateFolder(CreateFolderArg createFolderArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
CreateFolderArg	createFolderArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCreateFolder(String, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the create folder route.

Declaration

[Obsolete("This function is deprecated, please use BeginCreateFolderV2 instead.")]
public IAsyncResult BeginCreateFolder(string path, bool autorename = false, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	Path in the user's Dropbox to create.
System.Boolean	autorename	If there's a conflict, have the Dropbox server try to autorename the folder to avoid the conflict.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCreateFolderBatch(CreateFolderBatchArg, AsyncCallback, Object)

Begins an asynchronous send to the create folder batch route.

Declaration

public IAsyncResult BeginCreateFolderBatch(CreateFolderBatchArg createFolderBatchArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
CreateFolderBatchArg	createFolderBatchArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCreateFolderBatch(IEnumerable<String>, Boolean, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the create folder batch route.

Declaration

public IAsyncResult BeginCreateFolderBatch(IEnumerable<string> paths, bool autorename = false, bool forceAsync = false, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.String>	paths	List of paths to be created in the user's Dropbox. Duplicate path arguments in the batch are considered only once.
System.Boolean	autorename	If there's a conflict, have the Dropbox server try to autorename the folder to avoid the conflict.
System.Boolean	forceAsync	Whether to force the create to happen asynchronously.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCreateFolderBatchCheck(PollArg, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginCreateFolderBatchCheck(PollArg pollArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCreateFolderBatchCheck(String, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginCreateFolderBatchCheck(string asyncJobId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCreateFolderV2(CreateFolderArg, AsyncCallback, Object)

Begins an asynchronous send to the create folder route.

Declaration

public IAsyncResult BeginCreateFolderV2(CreateFolderArg createFolderArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
CreateFolderArg	createFolderArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginCreateFolderV2(String, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the create folder route.

Declaration

public IAsyncResult BeginCreateFolderV2(string path, bool autorename = false, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	Path in the user's Dropbox to create.
System.Boolean	autorename	If there's a conflict, have the Dropbox server try to autorename the folder to avoid the conflict.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginDelete(DeleteArg, AsyncCallback, Object)

Begins an asynchronous send to the delete route.

Declaration

[Obsolete("This function is deprecated, please use BeginDeleteV2 instead.")]
public IAsyncResult BeginDelete(DeleteArg deleteArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
DeleteArg	deleteArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginDelete(String, String, AsyncCallback, Object)

Begins an asynchronous send to the delete route.

Declaration

[Obsolete("This function is deprecated, please use BeginDeleteV2 instead.")]
public IAsyncResult BeginDelete(string path, string parentRev = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	Path in the user's Dropbox to delete.
System.String	parentRev	Perform delete if given "rev" matches the existing file's latest "rev". This field does not support deleting a folder.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginDeleteBatch(DeleteBatchArg, AsyncCallback, Object)

Begins an asynchronous send to the delete batch route.

Declaration

public IAsyncResult BeginDeleteBatch(DeleteBatchArg deleteBatchArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
DeleteBatchArg	deleteBatchArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginDeleteBatch(IEnumerable<DeleteArg>, AsyncCallback, Object)

Begins an asynchronous send to the delete batch route.

Declaration

public IAsyncResult BeginDeleteBatch(IEnumerable<DeleteArg> entries, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<DeleteArg>	entries	The entries
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginDeleteBatchCheck(PollArg, AsyncCallback, Object)

Begins an asynchronous send to the delete batch check route.

Declaration

public IAsyncResult BeginDeleteBatchCheck(PollArg pollArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginDeleteBatchCheck(String, AsyncCallback, Object)

Begins an asynchronous send to the delete batch check route.

Declaration

public IAsyncResult BeginDeleteBatchCheck(string asyncJobId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginDeleteV2(DeleteArg, AsyncCallback, Object)

Begins an asynchronous send to the delete route.

Declaration

public IAsyncResult BeginDeleteV2(DeleteArg deleteArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
DeleteArg	deleteArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginDeleteV2(String, String, AsyncCallback, Object)

Begins an asynchronous send to the delete route.

Declaration

public IAsyncResult BeginDeleteV2(string path, string parentRev = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	Path in the user's Dropbox to delete.
System.String	parentRev	Perform delete if given "rev" matches the existing file's latest "rev". This field does not support deleting a folder.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginDownload(DownloadArg, AsyncCallback, Object)

Begins an asynchronous send to the download route.

Declaration

public IAsyncResult BeginDownload(DownloadArg downloadArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
DownloadArg	downloadArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginDownload(String, String, AsyncCallback, Object)

Begins an asynchronous send to the download route.

Declaration

public IAsyncResult BeginDownload(string path, string rev = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	The path of the file to download.
System.String	rev	Please specify revision in path instead.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginDownloadZip(DownloadZipArg, AsyncCallback, Object)

Begins an asynchronous send to the download zip route.

Declaration

public IAsyncResult BeginDownloadZip(DownloadZipArg downloadZipArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
DownloadZipArg	downloadZipArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginDownloadZip(String, AsyncCallback, Object)

Begins an asynchronous send to the download zip route.

Declaration

public IAsyncResult BeginDownloadZip(string path, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	The path of the folder to download.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginExport(ExportArg, AsyncCallback, Object)

Begins an asynchronous send to the export route.

Declaration

public IAsyncResult BeginExport(ExportArg exportArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ExportArg	exportArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginExport(String, String, AsyncCallback, Object)

Begins an asynchronous send to the export route.

Declaration

public IAsyncResult BeginExport(string path, string exportFormat = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	The path of the file to be exported.
System.String	exportFormat	The file format to which the file should be exported. This must be one of the formats listed in the file's export_options returned by GetMetadataAsync(GetMetadataArg). If none is specified, the default format (specified in export_as in file metadata) will be used.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginGetFileLockBatch(LockFileBatchArg, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginGetFileLockBatch(LockFileBatchArg lockFileBatchArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
LockFileBatchArg	lockFileBatchArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginGetFileLockBatch(IEnumerable<LockFileArg>, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginGetFileLockBatch(IEnumerable<LockFileArg> entries, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<LockFileArg>	entries	List of 'entries'. Each 'entry' contains a path of the file which will be locked or queried. Duplicate path arguments in the batch are considered only once.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginGetMetadata(GetMetadataArg, AsyncCallback, Object)

Begins an asynchronous send to the get metadata route.

Declaration

public IAsyncResult BeginGetMetadata(GetMetadataArg getMetadataArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetMetadataArg	getMetadataArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginGetMetadata(String, Boolean, Boolean, Boolean, TemplateFilterBase, AsyncCallback, Object)

Begins an asynchronous send to the get metadata route.

Declaration

public IAsyncResult BeginGetMetadata(string path, bool includeMediaInfo = false, bool includeDeleted = false, bool includeHasExplicitSharedMembers = false, TemplateFilterBase includePropertyGroups = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	The path of a file or folder on Dropbox.
System.Boolean	includeMediaInfo	If true, MediaInfo is set for photo and video.
System.Boolean	includeDeleted	If true, DeletedMetadata will be returned for deleted file or folder, otherwise LookupError.NotFound will be returned.
System.Boolean	includeHasExplicitSharedMembers	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
TemplateFilterBase	includePropertyGroups	If set to a valid list of template IDs, PropertyGroups is set if there exists property data associated with the file and each of the listed templates.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginGetPreview(PreviewArg, AsyncCallback, Object)

Begins an asynchronous send to the get preview route.

Declaration

public IAsyncResult BeginGetPreview(PreviewArg previewArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PreviewArg	previewArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginGetPreview(String, String, AsyncCallback, Object)

Begins an asynchronous send to the get preview route.

Declaration

public IAsyncResult BeginGetPreview(string path, string rev = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	The path of the file to preview.
System.String	rev	Please specify revision in path instead.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginGetTemporaryLink(GetTemporaryLinkArg, AsyncCallback, Object)

Begins an asynchronous send to the get temporary link route.

Declaration

public IAsyncResult BeginGetTemporaryLink(GetTemporaryLinkArg getTemporaryLinkArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetTemporaryLinkArg	getTemporaryLinkArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginGetTemporaryLink(String, AsyncCallback, Object)

Begins an asynchronous send to the get temporary link route.

Declaration

public IAsyncResult BeginGetTemporaryLink(string path, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	The path to the file you want a temporary link to.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginGetTemporaryUploadLink(CommitInfo, Double, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginGetTemporaryUploadLink(CommitInfo commitInfo, double duration = 14400, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
CommitInfo	commitInfo	Contains the path and other optional modifiers for the future upload commit. Equivalent to the parameters provided to UploadAsync(UploadArg, Stream).
System.Double	duration	How long before this link expires, in seconds. Attempting to start an upload with this link longer than this period of time after link creation will result in an error.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginGetTemporaryUploadLink(GetTemporaryUploadLinkArg, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginGetTemporaryUploadLink(GetTemporaryUploadLinkArg getTemporaryUploadLinkArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetTemporaryUploadLinkArg	getTemporaryUploadLinkArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginGetThumbnail(ThumbnailArg, AsyncCallback, Object)

Begins an asynchronous send to the get thumbnail route.

Declaration

public IAsyncResult BeginGetThumbnail(ThumbnailArg thumbnailArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ThumbnailArg	thumbnailArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginGetThumbnail(String, ThumbnailFormat, ThumbnailSize, ThumbnailMode, AsyncCallback, Object)

Begins an asynchronous send to the get thumbnail route.

Declaration

public IAsyncResult BeginGetThumbnail(string path, ThumbnailFormat format = null, ThumbnailSize size = null, ThumbnailMode mode = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	The path to the image file you want to thumbnail.
ThumbnailFormat	format	The format for the thumbnail image, jpeg (default) or png. For images that are photos, jpeg should be preferred, while png is better for screenshots and digital arts.
ThumbnailSize	size	The size for the thumbnail image.
ThumbnailMode	mode	How to resize and crop the image to achieve the desired size.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginGetThumbnailBatch(GetThumbnailBatchArg, AsyncCallback, Object)

Begins an asynchronous send to the get thumbnail batch route.

Declaration

public IAsyncResult BeginGetThumbnailBatch(GetThumbnailBatchArg getThumbnailBatchArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetThumbnailBatchArg	getThumbnailBatchArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginGetThumbnailBatch(IEnumerable<ThumbnailArg>, AsyncCallback, Object)

Begins an asynchronous send to the get thumbnail batch route.

Declaration

public IAsyncResult BeginGetThumbnailBatch(IEnumerable<ThumbnailArg> entries, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<ThumbnailArg>	entries	List of files to get thumbnails.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginGetThumbnailV2(PathOrLink, ThumbnailFormat, ThumbnailSize, ThumbnailMode, AsyncCallback, Object)

Begins an asynchronous send to the get thumbnail route.

Declaration

public IAsyncResult BeginGetThumbnailV2(PathOrLink resource, ThumbnailFormat format = null, ThumbnailSize size = null, ThumbnailMode mode = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
PathOrLink	resource	Information specifying which file to preview. This could be a path to a file, a shared link pointing to a file, or a shared link pointing to a folder, with a relative path.
ThumbnailFormat	format	The format for the thumbnail image, jpeg (default) or png. For images that are photos, jpeg should be preferred, while png is better for screenshots and digital arts.
ThumbnailSize	size	The size for the thumbnail image.
ThumbnailMode	mode	How to resize and crop the image to achieve the desired size.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginGetThumbnailV2(ThumbnailV2Arg, AsyncCallback, Object)

Begins an asynchronous send to the get thumbnail route.

Declaration

public IAsyncResult BeginGetThumbnailV2(ThumbnailV2Arg thumbnailV2Arg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ThumbnailV2Arg	thumbnailV2Arg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginListFolder(ListFolderArg, AsyncCallback, Object)

Begins an asynchronous send to the list folder route.

Declaration

public IAsyncResult BeginListFolder(ListFolderArg listFolderArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListFolderArg	listFolderArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginListFolder(String, Boolean, Boolean, Boolean, Boolean, Boolean, Nullable<UInt32>, SharedLink, TemplateFilterBase, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the list folder route.

Declaration

public IAsyncResult BeginListFolder(string path, bool recursive = false, bool includeMediaInfo = false, bool includeDeleted = false, bool includeHasExplicitSharedMembers = false, bool includeMountedFolders = true, uint? limit = null, SharedLink sharedLink = null, TemplateFilterBase includePropertyGroups = null, bool includeNonDownloadableFiles = true, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	A unique identifier for the file.
System.Boolean	recursive	If true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders.
System.Boolean	includeMediaInfo	If true, MediaInfo is set for photo and video. This parameter will no longer have an effect starting December 2, 2019.
System.Boolean	includeDeleted	If true, the results will include entries for files and folders that used to exist but were deleted.
System.Boolean	includeHasExplicitSharedMembers	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
System.Boolean	includeMountedFolders	If true, the results will include entries under mounted folders which includes app folder, shared folder and team folder.
System.Nullable<System.UInt32>	limit	The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases.
SharedLink	sharedLink	A shared link to list the contents of. If the link is password-protected, the password must be provided. If this field is present, Path will be relative to root of the shared link. Only non-recursive mode is supported for shared link.
TemplateFilterBase	includePropertyGroups	If set to a valid list of template IDs, PropertyGroups is set if there exists property data associated with the file and each of the listed templates.
System.Boolean	includeNonDownloadableFiles	If true, include files that are not downloadable, i.e. Google Docs.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginListFolderContinue(ListFolderContinueArg, AsyncCallback, Object)

Begins an asynchronous send to the list folder continue route.

Declaration

public IAsyncResult BeginListFolderContinue(ListFolderContinueArg listFolderContinueArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListFolderContinueArg	listFolderContinueArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginListFolderContinue(String, AsyncCallback, Object)

Begins an asynchronous send to the list folder continue route.

Declaration

public IAsyncResult BeginListFolderContinue(string cursor, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	cursor	The cursor returned by your last call to ListFolderAsync(ListFolderArg) ListFolderAsync(ListFolderArg) or ListFolderContinueAsync(ListFolderContinueArg) ListFolderContinueAsync(ListFolderContinueArg).
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginListFolderGetLatestCursor(ListFolderArg, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginListFolderGetLatestCursor(ListFolderArg listFolderArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListFolderArg	listFolderArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginListFolderGetLatestCursor(String, Boolean, Boolean, Boolean, Boolean, Boolean, Nullable<UInt32>, SharedLink, TemplateFilterBase, Boolean, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginListFolderGetLatestCursor(string path, bool recursive = false, bool includeMediaInfo = false, bool includeDeleted = false, bool includeHasExplicitSharedMembers = false, bool includeMountedFolders = true, uint? limit = null, SharedLink sharedLink = null, TemplateFilterBase includePropertyGroups = null, bool includeNonDownloadableFiles = true, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	A unique identifier for the file.
System.Boolean	recursive	If true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders.
System.Boolean	includeMediaInfo	If true, MediaInfo is set for photo and video. This parameter will no longer have an effect starting December 2, 2019.
System.Boolean	includeDeleted	If true, the results will include entries for files and folders that used to exist but were deleted.
System.Boolean	includeHasExplicitSharedMembers	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
System.Boolean	includeMountedFolders	If true, the results will include entries under mounted folders which includes app folder, shared folder and team folder.
System.Nullable<System.UInt32>	limit	The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases.
SharedLink	sharedLink	A shared link to list the contents of. If the link is password-protected, the password must be provided. If this field is present, Path will be relative to root of the shared link. Only non-recursive mode is supported for shared link.
TemplateFilterBase	includePropertyGroups	If set to a valid list of template IDs, PropertyGroups is set if there exists property data associated with the file and each of the listed templates.
System.Boolean	includeNonDownloadableFiles	If true, include files that are not downloadable, i.e. Google Docs.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginListFolderLongpoll(ListFolderLongpollArg, AsyncCallback, Object)

Begins an asynchronous send to the list folder longpoll route.

Declaration

public IAsyncResult BeginListFolderLongpoll(ListFolderLongpollArg listFolderLongpollArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListFolderLongpollArg	listFolderLongpollArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginListFolderLongpoll(String, UInt64, AsyncCallback, Object)

Begins an asynchronous send to the list folder longpoll route.

Declaration

public IAsyncResult BeginListFolderLongpoll(string cursor, ulong timeout = 30UL, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	cursor	A cursor as returned by ListFolderAsync(ListFolderArg) ListFolderAsync(ListFolderArg) or ListFolderContinueAsync(ListFolderContinueArg) ListFolderContinueAsync(ListFolderContinueArg). Cursors retrieved by setting IncludeMediaInfo to true are not supported.
System.UInt64	timeout	A timeout in seconds. The request will block for at most this length of time, plus up to 90 seconds of random jitter added to avoid the thundering herd problem. Care should be taken when using this parameter, as some network infrastructure does not support long timeouts.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginListRevisions(ListRevisionsArg, AsyncCallback, Object)

Begins an asynchronous send to the list revisions route.

Declaration

public IAsyncResult BeginListRevisions(ListRevisionsArg listRevisionsArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListRevisionsArg	listRevisionsArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginListRevisions(String, ListRevisionsMode, UInt64, AsyncCallback, Object)

Begins an asynchronous send to the list revisions route.

Declaration

public IAsyncResult BeginListRevisions(string path, ListRevisionsMode mode = null, ulong limit = 10UL, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	The path to the file you want to see the revisions of.
ListRevisionsMode	mode	Determines the behavior of the API in listing the revisions for a given file path or id.
System.UInt64	limit	The maximum number of revision entries returned.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginLockFileBatch(LockFileBatchArg, AsyncCallback, Object)

Begins an asynchronous send to the lock file batch route.

Declaration

public IAsyncResult BeginLockFileBatch(LockFileBatchArg lockFileBatchArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
LockFileBatchArg	lockFileBatchArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginLockFileBatch(IEnumerable<LockFileArg>, AsyncCallback, Object)

Begins an asynchronous send to the lock file batch route.

Declaration

public IAsyncResult BeginLockFileBatch(IEnumerable<LockFileArg> entries, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<LockFileArg>	entries	List of 'entries'. Each 'entry' contains a path of the file which will be locked or queried. Duplicate path arguments in the batch are considered only once.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginMove(RelocationArg, AsyncCallback, Object)

Begins an asynchronous send to the move route.

Declaration

[Obsolete("This function is deprecated, please use BeginMoveV2 instead.")]
public IAsyncResult BeginMove(RelocationArg relocationArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RelocationArg	relocationArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginMove(String, String, Boolean, Boolean, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the move route.

Declaration

[Obsolete("This function is deprecated, please use BeginMoveV2 instead.")]
public IAsyncResult BeginMove(string fromPath, string toPath, bool allowSharedFolder = false, bool autorename = false, bool allowOwnershipTransfer = false, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	fromPath	Path in the user's Dropbox to be copied or moved.
System.String	toPath	Path in the user's Dropbox that is the destination.
System.Boolean	allowSharedFolder	This flag has no effect.
System.Boolean	autorename	If there's a conflict, have the Dropbox server try to autorename the file to avoid the conflict.
System.Boolean	allowOwnershipTransfer	Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginMoveBatch(RelocationBatchArg, AsyncCallback, Object)

Begins an asynchronous send to the move batch route.

Declaration

[Obsolete("This function is deprecated, please use BeginMoveBatchV2 instead.")]
public IAsyncResult BeginMoveBatch(RelocationBatchArg relocationBatchArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RelocationBatchArg	relocationBatchArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginMoveBatch(IEnumerable<RelocationPath>, Boolean, Boolean, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the move batch route.

Declaration

[Obsolete("This function is deprecated, please use BeginMoveBatchV2 instead.")]
public IAsyncResult BeginMoveBatch(IEnumerable<RelocationPath> entries, bool autorename = false, bool allowSharedFolder = false, bool allowOwnershipTransfer = false, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<RelocationPath>	entries	List of entries to be moved or copied. Each entry is RelocationPath.
System.Boolean	autorename	If there's a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict.
System.Boolean	allowSharedFolder	This flag has no effect.
System.Boolean	allowOwnershipTransfer	Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginMoveBatchCheck(PollArg, AsyncCallback, Object)

Begins an asynchronous send to the move batch check route.

Declaration

[Obsolete("This function is deprecated, please use BeginMoveBatchCheckV2 instead.")]
public IAsyncResult BeginMoveBatchCheck(PollArg pollArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginMoveBatchCheck(String, AsyncCallback, Object)

Begins an asynchronous send to the move batch check route.

Declaration

[Obsolete("This function is deprecated, please use BeginMoveBatchCheckV2 instead.")]
public IAsyncResult BeginMoveBatchCheck(string asyncJobId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginMoveBatchCheckV2(PollArg, AsyncCallback, Object)

Begins an asynchronous send to the move batch check route.

Declaration

public IAsyncResult BeginMoveBatchCheckV2(PollArg pollArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginMoveBatchCheckV2(String, AsyncCallback, Object)

Begins an asynchronous send to the move batch check route.

Declaration

public IAsyncResult BeginMoveBatchCheckV2(string asyncJobId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginMoveBatchV2(MoveBatchArg, AsyncCallback, Object)

Begins an asynchronous send to the move batch route.

Declaration

public IAsyncResult BeginMoveBatchV2(MoveBatchArg moveBatchArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
MoveBatchArg	moveBatchArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginMoveBatchV2(IEnumerable<RelocationPath>, Boolean, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the move batch route.

Declaration

public IAsyncResult BeginMoveBatchV2(IEnumerable<RelocationPath> entries, bool autorename = false, bool allowOwnershipTransfer = false, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<RelocationPath>	entries	List of entries to be moved or copied. Each entry is RelocationPath.
System.Boolean	autorename	If there's a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict.
System.Boolean	allowOwnershipTransfer	Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginMoveV2(RelocationArg, AsyncCallback, Object)

Begins an asynchronous send to the move route.

Declaration

public IAsyncResult BeginMoveV2(RelocationArg relocationArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RelocationArg	relocationArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginMoveV2(String, String, Boolean, Boolean, Boolean, AsyncCallback, Object)

Begins an asynchronous send to the move route.

Declaration

public IAsyncResult BeginMoveV2(string fromPath, string toPath, bool allowSharedFolder = false, bool autorename = false, bool allowOwnershipTransfer = false, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	fromPath	Path in the user's Dropbox to be copied or moved.
System.String	toPath	Path in the user's Dropbox that is the destination.
System.Boolean	allowSharedFolder	This flag has no effect.
System.Boolean	autorename	If there's a conflict, have the Dropbox server try to autorename the file to avoid the conflict.
System.Boolean	allowOwnershipTransfer	Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginPaperCreate(PaperCreateArg, Stream, AsyncCallback, Object)

Begins an asynchronous send to the paper create route.

Declaration

public IAsyncResult BeginPaperCreate(PaperCreateArg paperCreateArg, Stream body, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PaperCreateArg	paperCreateArg	The request parameters.
System.IO.Stream	body	The content to upload.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginPaperCreate(String, ImportFormat, Stream, AsyncCallback, Object)

Begins an asynchronous send to the paper create route.

Declaration

public IAsyncResult BeginPaperCreate(string path, ImportFormat importFormat, Stream body, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	The fully qualified path to the location in the user's Dropbox where the Paper Doc should be created. This should include the document's title and end with .paper.
ImportFormat	importFormat	The format of the provided data.
System.IO.Stream	body	The document to upload
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginPaperUpdate(PaperUpdateArg, Stream, AsyncCallback, Object)

Begins an asynchronous send to the paper update route.

Declaration

public IAsyncResult BeginPaperUpdate(PaperUpdateArg paperUpdateArg, Stream body, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PaperUpdateArg	paperUpdateArg	The request parameters.
System.IO.Stream	body	The content to upload.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginPaperUpdate(String, ImportFormat, PaperDocUpdatePolicy, Nullable<Int64>, Stream, AsyncCallback, Object)

Begins an asynchronous send to the paper update route.

Declaration

public IAsyncResult BeginPaperUpdate(string path, ImportFormat importFormat, PaperDocUpdatePolicy docUpdatePolicy, long? paperRevision = null, Stream body = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	Path in the user's Dropbox to update. The path must correspond to a Paper doc or an error will be returned.
ImportFormat	importFormat	The format of the provided data.
PaperDocUpdatePolicy	docUpdatePolicy	How the provided content should be applied to the doc.
System.Nullable<System.Int64>	paperRevision	The latest doc revision. Required when doc_update_policy is update. This value must match the current revision of the doc or error revision_mismatch will be returned.
System.IO.Stream	body	The document to upload
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginPermanentlyDelete(DeleteArg, AsyncCallback, Object)

Begins an asynchronous send to the permanently delete route.

Declaration

public IAsyncResult BeginPermanentlyDelete(DeleteArg deleteArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
DeleteArg	deleteArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginPermanentlyDelete(String, String, AsyncCallback, Object)

Begins an asynchronous send to the permanently delete route.

Declaration

public IAsyncResult BeginPermanentlyDelete(string path, string parentRev = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	Path in the user's Dropbox to delete.
System.String	parentRev	Perform delete if given "rev" matches the existing file's latest "rev". This field does not support deleting a folder.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginPropertiesAdd(AddPropertiesArg, AsyncCallback, Object)

Begins an asynchronous send to the properties add route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginPropertiesAdd(AddPropertiesArg addPropertiesArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
AddPropertiesArg	addPropertiesArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginPropertiesAdd(String, IEnumerable<PropertyGroup>, AsyncCallback, Object)

Begins an asynchronous send to the properties add route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginPropertiesAdd(string path, IEnumerable<PropertyGroup> propertyGroups, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	A unique identifier for the file or folder.
System.Collections.Generic.IEnumerable<PropertyGroup>	propertyGroups	The property groups which are to be added to a Dropbox file. No two groups in the input should refer to the same template.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginPropertiesOverwrite(OverwritePropertyGroupArg, AsyncCallback, Object)

Begins an asynchronous send to the properties overwrite route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginPropertiesOverwrite(OverwritePropertyGroupArg overwritePropertyGroupArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
OverwritePropertyGroupArg	overwritePropertyGroupArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginPropertiesOverwrite(String, IEnumerable<PropertyGroup>, AsyncCallback, Object)

Begins an asynchronous send to the properties overwrite route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginPropertiesOverwrite(string path, IEnumerable<PropertyGroup> propertyGroups, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	A unique identifier for the file or folder.
System.Collections.Generic.IEnumerable<PropertyGroup>	propertyGroups	The property groups "snapshot" updates to force apply. No two groups in the input should refer to the same template.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginPropertiesRemove(RemovePropertiesArg, AsyncCallback, Object)

Begins an asynchronous send to the properties remove route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginPropertiesRemove(RemovePropertiesArg removePropertiesArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RemovePropertiesArg	removePropertiesArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginPropertiesRemove(String, IEnumerable<String>, AsyncCallback, Object)

Begins an asynchronous send to the properties remove route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginPropertiesRemove(string path, IEnumerable<string> propertyTemplateIds, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	A unique identifier for the file or folder.
System.Collections.Generic.IEnumerable<System.String>	propertyTemplateIds	A list of identifiers for a template created by TemplatesAddForUserAsync(AddTemplateArg) or TemplatesAddForTeamAsync(AddTemplateArg).
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginPropertiesTemplateGet(GetTemplateArg, AsyncCallback, Object)

Begins an asynchronous send to the properties template get route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginPropertiesTemplateGet(GetTemplateArg getTemplateArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetTemplateArg	getTemplateArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginPropertiesTemplateGet(String, AsyncCallback, Object)

Begins an asynchronous send to the properties template get route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginPropertiesTemplateGet(string templateId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	templateId	An identifier for template added by route See TemplatesAddForUserAsync(AddTemplateArg) or TemplatesAddForTeamAsync(AddTemplateArg).
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginPropertiesTemplateList(AsyncCallback, Object)

Begins an asynchronous send to the properties template list route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginPropertiesTemplateList(AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginPropertiesUpdate(UpdatePropertiesArg, AsyncCallback, Object)

Begins an asynchronous send to the properties update route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginPropertiesUpdate(UpdatePropertiesArg updatePropertiesArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UpdatePropertiesArg	updatePropertiesArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginPropertiesUpdate(String, IEnumerable<PropertyGroupUpdate>, AsyncCallback, Object)

Begins an asynchronous send to the properties update route.

Declaration

[Obsolete("This function is deprecated")]
public IAsyncResult BeginPropertiesUpdate(string path, IEnumerable<PropertyGroupUpdate> updatePropertyGroups, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	A unique identifier for the file or folder.
System.Collections.Generic.IEnumerable<PropertyGroupUpdate>	updatePropertyGroups	The property groups "delta" updates to apply.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginRestore(RestoreArg, AsyncCallback, Object)

Begins an asynchronous send to the restore route.

Declaration

public IAsyncResult BeginRestore(RestoreArg restoreArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RestoreArg	restoreArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginRestore(String, String, AsyncCallback, Object)

Begins an asynchronous send to the restore route.

Declaration

public IAsyncResult BeginRestore(string path, string rev, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	The path to save the restored file.
System.String	rev	The revision to restore.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginSaveUrl(SaveUrlArg, AsyncCallback, Object)

Begins an asynchronous send to the save url route.

Declaration

public IAsyncResult BeginSaveUrl(SaveUrlArg saveUrlArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
SaveUrlArg	saveUrlArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginSaveUrl(String, String, AsyncCallback, Object)

Begins an asynchronous send to the save url route.

Declaration

public IAsyncResult BeginSaveUrl(string path, string url, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	The path in Dropbox where the URL will be saved to.
System.String	url	The URL to be saved.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginSaveUrlCheckJobStatus(PollArg, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginSaveUrlCheckJobStatus(PollArg pollArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginSaveUrlCheckJobStatus(String, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginSaveUrlCheckJobStatus(string asyncJobId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginSearch(SearchArg, AsyncCallback, Object)

Begins an asynchronous send to the search route.

Declaration

[Obsolete("This function is deprecated, please use BeginSearchV2 instead.")]
public IAsyncResult BeginSearch(SearchArg searchArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
SearchArg	searchArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginSearch(String, String, UInt64, UInt64, SearchMode, AsyncCallback, Object)

Begins an asynchronous send to the search route.

Declaration

[Obsolete("This function is deprecated, please use BeginSearchV2 instead.")]
public IAsyncResult BeginSearch(string path, string query, ulong start = 0UL, ulong maxResults = 100UL, SearchMode mode = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	The path in the user's Dropbox to search. Should probably be a folder.
System.String	query	The string to search for. Query string may be rewritten to improve relevance of results. The string is split on spaces into multiple tokens. For file name searching, the last token is used for prefix matching (i.e. "bat c" matches "bat cave" but not "batman car").
System.UInt64	start	The starting index within the search results (used for paging).
System.UInt64	maxResults	The maximum number of search results to return.
SearchMode	mode	The search mode (filename, filename_and_content, or deleted_filename). Note that searching file content is only available for Dropbox Business accounts.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginSearchContinueV2(SearchV2ContinueArg, AsyncCallback, Object)

Begins an asynchronous send to the search continue route.

Declaration

public IAsyncResult BeginSearchContinueV2(SearchV2ContinueArg searchV2ContinueArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
SearchV2ContinueArg	searchV2ContinueArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginSearchContinueV2(String, AsyncCallback, Object)

Begins an asynchronous send to the search continue route.

Declaration

public IAsyncResult BeginSearchContinueV2(string cursor, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	cursor	The cursor returned by your last call to SearchV2Async(SearchV2Arg). Used to fetch the next page of results.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginSearchV2(SearchV2Arg, AsyncCallback, Object)

Begins an asynchronous send to the search route.

Declaration

public IAsyncResult BeginSearchV2(SearchV2Arg searchV2Arg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
SearchV2Arg	searchV2Arg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginSearchV2(String, SearchOptions, SearchMatchFieldOptions, Nullable<Boolean>, AsyncCallback, Object)

Begins an asynchronous send to the search route.

Declaration

public IAsyncResult BeginSearchV2(string query, SearchOptions options = null, SearchMatchFieldOptions matchFieldOptions = null, bool? includeHighlights = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	query	The string to search for. May match across multiple fields based on the request arguments.
SearchOptions	options	Options for more targeted search results.
SearchMatchFieldOptions	matchFieldOptions	Options for search results match fields.
System.Nullable<System.Boolean>	includeHighlights	Deprecated and moved this option to SearchMatchFieldOptions.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginTagsAdd(AddTagArg, AsyncCallback, Object)

Begins an asynchronous send to the tags add route.

Declaration

public IAsyncResult BeginTagsAdd(AddTagArg addTagArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
AddTagArg	addTagArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginTagsAdd(String, String, AsyncCallback, Object)

Begins an asynchronous send to the tags add route.

Declaration

public IAsyncResult BeginTagsAdd(string path, string tagText, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	Path to the item to be tagged.
System.String	tagText	The value of the tag to add.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginTagsGet(GetTagsArg, AsyncCallback, Object)

Begins an asynchronous send to the tags get route.

Declaration

public IAsyncResult BeginTagsGet(GetTagsArg getTagsArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetTagsArg	getTagsArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginTagsGet(IEnumerable<String>, AsyncCallback, Object)

Begins an asynchronous send to the tags get route.

Declaration

public IAsyncResult BeginTagsGet(IEnumerable<string> paths, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.String>	paths	Path to the items.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginTagsRemove(RemoveTagArg, AsyncCallback, Object)

Begins an asynchronous send to the tags remove route.

Declaration

public IAsyncResult BeginTagsRemove(RemoveTagArg removeTagArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
RemoveTagArg	removeTagArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginTagsRemove(String, String, AsyncCallback, Object)

Begins an asynchronous send to the tags remove route.

Declaration

public IAsyncResult BeginTagsRemove(string path, string tagText, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	Path to the item to tag.
System.String	tagText	The tag to remove.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginUnlockFileBatch(UnlockFileBatchArg, AsyncCallback, Object)

Begins an asynchronous send to the unlock file batch route.

Declaration

public IAsyncResult BeginUnlockFileBatch(UnlockFileBatchArg unlockFileBatchArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UnlockFileBatchArg	unlockFileBatchArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginUnlockFileBatch(IEnumerable<UnlockFileArg>, AsyncCallback, Object)

Begins an asynchronous send to the unlock file batch route.

Declaration

public IAsyncResult BeginUnlockFileBatch(IEnumerable<UnlockFileArg> entries, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<UnlockFileArg>	entries	List of 'entries'. Each 'entry' contains a path of the file which will be unlocked. Duplicate path arguments in the batch are considered only once.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginUpload(UploadArg, Stream, AsyncCallback, Object)

Begins an asynchronous send to the upload route.

Declaration

public IAsyncResult BeginUpload(UploadArg uploadArg, Stream body, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UploadArg	uploadArg	The request parameters.
System.IO.Stream	body	The content to upload.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginUpload(String, WriteMode, Boolean, Nullable<DateTime>, Boolean, IEnumerable<PropertyGroup>, Boolean, String, Stream, AsyncCallback, Object)

Begins an asynchronous send to the upload route.

Declaration

public IAsyncResult BeginUpload(string path, WriteMode mode = null, bool autorename = false, DateTime? clientModified = null, bool mute = false, IEnumerable<PropertyGroup> propertyGroups = null, bool strictConflict = false, string contentHash = null, Stream body = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	path	Path in the user's Dropbox to save the file.
WriteMode	mode	Selects what to do if the file already exists.
System.Boolean	autorename	If there's a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict.
System.Nullable<System.DateTime>	clientModified	The value to store as the clientModified timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified.
System.Boolean	mute	Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If true, this tells the clients that this modification shouldn't result in a user notification.
System.Collections.Generic.IEnumerable<PropertyGroup>	propertyGroups	List of custom properties to add to file.
System.Boolean	strictConflict	Be more strict about how each WriteMode detects conflict. For example, always return a conflict error when mode = WriteMode.Update and the given "rev" doesn't match the existing file's "rev", even if the existing file has been deleted. This also forces a conflict even when the target path refers to a file with identical contents.
System.String	contentHash	A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash page.
System.IO.Stream	body	The document to upload
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginUploadSessionAppend(UploadSessionCursor, Stream, AsyncCallback, Object)

Begins an asynchronous send to the upload session append route.

Declaration

[Obsolete("This function is deprecated, please use BeginUploadSessionAppendV2 instead.")]
public IAsyncResult BeginUploadSessionAppend(UploadSessionCursor uploadSessionCursor, Stream body, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UploadSessionCursor	uploadSessionCursor	The request parameters.
System.IO.Stream	body	The content to upload.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginUploadSessionAppend(String, UInt64, Stream, AsyncCallback, Object)

Begins an asynchronous send to the upload session append route.

Declaration

[Obsolete("This function is deprecated, please use BeginUploadSessionAppendV2 instead.")]
public IAsyncResult BeginUploadSessionAppend(string sessionId, ulong offset, Stream body, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	sessionId	The upload session ID (returned by UploadSessionStartAsync(UploadSessionStartArg, Stream)).
System.UInt64	offset	Offset in bytes at which data should be appended. We use this to make sure upload data isn't lost or duplicated in the event of a network error.
System.IO.Stream	body	The document to upload
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginUploadSessionAppendV2(UploadSessionAppendArg, Stream, AsyncCallback, Object)

Begins an asynchronous send to the upload session append route.

Declaration

public IAsyncResult BeginUploadSessionAppendV2(UploadSessionAppendArg uploadSessionAppendArg, Stream body, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UploadSessionAppendArg	uploadSessionAppendArg	The request parameters.
System.IO.Stream	body	The content to upload.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginUploadSessionAppendV2(UploadSessionCursor, Boolean, String, Stream, AsyncCallback, Object)

Begins an asynchronous send to the upload session append route.

Declaration

public IAsyncResult BeginUploadSessionAppendV2(UploadSessionCursor cursor, bool close = false, string contentHash = null, Stream body = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
UploadSessionCursor	cursor	Contains the upload session ID and the offset.
System.Boolean	close	If true, the current session will be closed, at which point you won't be able to call UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) anymore with the current session.
System.String	contentHash	A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash page.
System.IO.Stream	body	The document to upload
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginUploadSessionFinish(UploadSessionCursor, CommitInfo, String, Stream, AsyncCallback, Object)

Begins an asynchronous send to the upload session finish route.

Declaration

public IAsyncResult BeginUploadSessionFinish(UploadSessionCursor cursor, CommitInfo commit, string contentHash = null, Stream body = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
UploadSessionCursor	cursor	Contains the upload session ID and the offset.
CommitInfo	commit	Contains the path and other optional modifiers for the commit.
System.String	contentHash	A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash page.
System.IO.Stream	body	The document to upload
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginUploadSessionFinish(UploadSessionFinishArg, Stream, AsyncCallback, Object)

Begins an asynchronous send to the upload session finish route.

Declaration

public IAsyncResult BeginUploadSessionFinish(UploadSessionFinishArg uploadSessionFinishArg, Stream body, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UploadSessionFinishArg	uploadSessionFinishArg	The request parameters.
System.IO.Stream	body	The content to upload.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginUploadSessionFinishBatch(UploadSessionFinishBatchArg, AsyncCallback, Object)

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

Declaration

[Obsolete("This function is deprecated, please use BeginUploadSessionFinishBatchV2 instead.")]
public IAsyncResult BeginUploadSessionFinishBatch(UploadSessionFinishBatchArg uploadSessionFinishBatchArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UploadSessionFinishBatchArg	uploadSessionFinishBatchArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginUploadSessionFinishBatch(IEnumerable<UploadSessionFinishArg>, AsyncCallback, Object)

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

Declaration

[Obsolete("This function is deprecated, please use BeginUploadSessionFinishBatchV2 instead.")]
public IAsyncResult BeginUploadSessionFinishBatch(IEnumerable<UploadSessionFinishArg> entries, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<UploadSessionFinishArg>	entries	Commit information for each file in the batch.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginUploadSessionFinishBatchCheck(PollArg, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginUploadSessionFinishBatchCheck(PollArg pollArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginUploadSessionFinishBatchCheck(String, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginUploadSessionFinishBatchCheck(string asyncJobId, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginUploadSessionFinishBatchV2(UploadSessionFinishBatchArg, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginUploadSessionFinishBatchV2(UploadSessionFinishBatchArg uploadSessionFinishBatchArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UploadSessionFinishBatchArg	uploadSessionFinishBatchArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginUploadSessionFinishBatchV2(IEnumerable<UploadSessionFinishArg>, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginUploadSessionFinishBatchV2(IEnumerable<UploadSessionFinishArg> entries, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<UploadSessionFinishArg>	entries	Commit information for each file in the batch.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginUploadSessionStart(UploadSessionStartArg, Stream, AsyncCallback, Object)

Begins an asynchronous send to the upload session start route.

Declaration

public IAsyncResult BeginUploadSessionStart(UploadSessionStartArg uploadSessionStartArg, Stream body, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UploadSessionStartArg	uploadSessionStartArg	The request parameters.
System.IO.Stream	body	The content to upload.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginUploadSessionStart(Boolean, UploadSessionType, String, Stream, AsyncCallback, Object)

Begins an asynchronous send to the upload session start route.

Declaration

public IAsyncResult BeginUploadSessionStart(bool close = false, UploadSessionType sessionType = null, string contentHash = null, Stream body = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.Boolean	close	If true, the current session will be closed, at which point you won't be able to call UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) anymore with the current session.
UploadSessionType	sessionType	Type of upload session you want to start. If not specified, default is UploadSessionType.Sequential.
System.String	contentHash	A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash page.
System.IO.Stream	body	The document to upload
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginUploadSessionStartBatch(UploadSessionStartBatchArg, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginUploadSessionStartBatch(UploadSessionStartBatchArg uploadSessionStartBatchArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UploadSessionStartBatchArg	uploadSessionStartBatchArg	The request parameters.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	state	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

BeginUploadSessionStartBatch(UInt64, UploadSessionType, AsyncCallback, Object)

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

Declaration

public IAsyncResult BeginUploadSessionStartBatch(ulong numSessions, UploadSessionType sessionType = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.UInt64	numSessions	The number of upload sessions to start.
UploadSessionType	sessionType	Type of upload session you want to start. If not specified, default is UploadSessionType.Sequential.
System.AsyncCallback	callback	The method to be called when the asynchronous send is completed.
System.Object	callbackState	A user provided object that distinguished this send from other send requests.

Returns

Type	Description
System.IAsyncResult	An object that represents the asynchronous send request.

CopyAsync(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.

Declaration

[Obsolete("This function is deprecated, please use CopyV2Async instead.")]
public Task<Metadata> CopyAsync(RelocationArg relocationArg)

Parameters

Type	Name	Description
RelocationArg	relocationArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<Metadata>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a RelocationError.

CopyAsync(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.

Declaration

[Obsolete("This function is deprecated, please use CopyV2Async instead.")]
public Task<Metadata> CopyAsync(string fromPath, string toPath, bool allowSharedFolder = false, bool autorename = false, bool allowOwnershipTransfer = false)

Parameters

Type	Name	Description
System.String	fromPath	Path in the user's Dropbox to be copied or moved.
System.String	toPath	Path in the user's Dropbox that is the destination.
System.Boolean	allowSharedFolder	This flag has no effect.
System.Boolean	autorename	If there's a conflict, have the Dropbox server try to autorename the file to avoid the conflict.
System.Boolean	allowOwnershipTransfer	Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.

Returns

Type	Description
System.Threading.Tasks.Task<Metadata>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a RelocationError.

CopyBatchAsync(RelocationBatchArg)

Copy 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 copy job in background. Please use CopyBatchCheckAsync(PollArg) to check the job status.

Declaration

[Obsolete("This function is deprecated, please use CopyBatchV2Async instead.")]
public Task<RelocationBatchLaunch> CopyBatchAsync(RelocationBatchArg relocationBatchArg)

Parameters

Type	Name	Description
RelocationBatchArg	relocationBatchArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<RelocationBatchLaunch>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

CopyBatchAsync(IEnumerable<RelocationPath>, Boolean, Boolean, Boolean)

Copy 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 copy job in background. Please use CopyBatchCheckAsync(PollArg) to check the job status.

Declaration

[Obsolete("This function is deprecated, please use CopyBatchV2Async instead.")]
public Task<RelocationBatchLaunch> CopyBatchAsync(IEnumerable<RelocationPath> entries, bool autorename = false, bool allowSharedFolder = false, bool allowOwnershipTransfer = false)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<RelocationPath>	entries	List of entries to be moved or copied. Each entry is RelocationPath.
System.Boolean	autorename	If there's a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict.
System.Boolean	allowSharedFolder	This flag has no effect.
System.Boolean	allowOwnershipTransfer	Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.

Returns

Type	Description
System.Threading.Tasks.Task<RelocationBatchLaunch>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

CopyBatchCheckAsync(PollArg)

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

Declaration

[Obsolete("This function is deprecated, please use CopyBatchCheckV2Async instead.")]
public Task<RelocationBatchJobStatus> CopyBatchCheckAsync(PollArg pollArg)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<RelocationBatchJobStatus>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

CopyBatchCheckAsync(String)

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

Declaration

[Obsolete("This function is deprecated, please use CopyBatchCheckV2Async instead.")]
public Task<RelocationBatchJobStatus> CopyBatchCheckAsync(string asyncJobId)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Returns

Type	Description
System.Threading.Tasks.Task<RelocationBatchJobStatus>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

CopyBatchCheckV2Async(PollArg)

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

Declaration

public Task<RelocationBatchV2JobStatus> CopyBatchCheckV2Async(PollArg pollArg)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<RelocationBatchV2JobStatus>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

CopyBatchCheckV2Async(String)

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

Declaration

public Task<RelocationBatchV2JobStatus> CopyBatchCheckV2Async(string asyncJobId)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Returns

Type	Description
System.Threading.Tasks.Task<RelocationBatchV2JobStatus>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

CopyBatchV2Async(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.

Declaration

public Task<RelocationBatchV2Launch> CopyBatchV2Async(RelocationBatchArgBase relocationBatchArgBase)

Parameters

Type	Name	Description
RelocationBatchArgBase	relocationBatchArgBase	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<RelocationBatchV2Launch>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

CopyBatchV2Async(IEnumerable<RelocationPath>, 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.

Declaration

public Task<RelocationBatchV2Launch> CopyBatchV2Async(IEnumerable<RelocationPath> entries, bool autorename = false)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<RelocationPath>	entries	List of entries to be moved or copied. Each entry is RelocationPath.
System.Boolean	autorename	If there's a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict.

Returns

Type	Description
System.Threading.Tasks.Task<RelocationBatchV2Launch>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

CopyReferenceGetAsync(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).

Declaration

public Task<GetCopyReferenceResult> CopyReferenceGetAsync(GetCopyReferenceArg getCopyReferenceArg)

Parameters

Type	Name	Description
GetCopyReferenceArg	getCopyReferenceArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<GetCopyReferenceResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a GetCopyReferenceError.

CopyReferenceGetAsync(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).

Declaration

public Task<GetCopyReferenceResult> CopyReferenceGetAsync(string path)

Parameters

Type	Name	Description
System.String	path	The path to the file or folder you want to get a copy reference to.

Returns

Type	Description
System.Threading.Tasks.Task<GetCopyReferenceResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a GetCopyReferenceError.

CopyReferenceSaveAsync(SaveCopyReferenceArg)

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

Declaration

public Task<SaveCopyReferenceResult> CopyReferenceSaveAsync(SaveCopyReferenceArg saveCopyReferenceArg)

Parameters

Type	Name	Description
SaveCopyReferenceArg	saveCopyReferenceArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<SaveCopyReferenceResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a SaveCopyReferenceError.

CopyReferenceSaveAsync(String, String)

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

Declaration

public Task<SaveCopyReferenceResult> CopyReferenceSaveAsync(string copyReference, string path)

Parameters

Type	Name	Description
System.String	copyReference	A copy reference returned by CopyReferenceGetAsync(GetCopyReferenceArg).
System.String	path	Path in the user's Dropbox that is the destination.

Returns

Type	Description
System.Threading.Tasks.Task<SaveCopyReferenceResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a SaveCopyReferenceError.

CopyV2Async(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.

Declaration

public Task<RelocationResult> CopyV2Async(RelocationArg relocationArg)

Parameters

Type	Name	Description
RelocationArg	relocationArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<RelocationResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a RelocationError.

CopyV2Async(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.

Declaration

public Task<RelocationResult> CopyV2Async(string fromPath, string toPath, bool allowSharedFolder = false, bool autorename = false, bool allowOwnershipTransfer = false)

Parameters

Type	Name	Description
System.String	fromPath	Path in the user's Dropbox to be copied or moved.
System.String	toPath	Path in the user's Dropbox that is the destination.
System.Boolean	allowSharedFolder	This flag has no effect.
System.Boolean	autorename	If there's a conflict, have the Dropbox server try to autorename the file to avoid the conflict.
System.Boolean	allowOwnershipTransfer	Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.

Returns

Type	Description
System.Threading.Tasks.Task<RelocationResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a RelocationError.

CreateFolderAsync(CreateFolderArg)

Create a folder at a given path.

Declaration

[Obsolete("This function is deprecated, please use CreateFolderV2Async instead.")]
public Task<FolderMetadata> CreateFolderAsync(CreateFolderArg createFolderArg)

Parameters

Type	Name	Description
CreateFolderArg	createFolderArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<FolderMetadata>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a CreateFolderError.

CreateFolderAsync(String, Boolean)

Create a folder at a given path.

Declaration

[Obsolete("This function is deprecated, please use CreateFolderV2Async instead.")]
public Task<FolderMetadata> CreateFolderAsync(string path, bool autorename = false)

Parameters

Type	Name	Description
System.String	path	Path in the user's Dropbox to create.
System.Boolean	autorename	If there's a conflict, have the Dropbox server try to autorename the folder to avoid the conflict.

Returns

Type	Description
System.Threading.Tasks.Task<FolderMetadata>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a CreateFolderError.

CreateFolderBatchAsync(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.

Declaration

public Task<CreateFolderBatchLaunch> CreateFolderBatchAsync(CreateFolderBatchArg createFolderBatchArg)

Parameters

Type	Name	Description
CreateFolderBatchArg	createFolderBatchArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<CreateFolderBatchLaunch>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

CreateFolderBatchAsync(IEnumerable<String>, 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.

Declaration

public Task<CreateFolderBatchLaunch> CreateFolderBatchAsync(IEnumerable<string> paths, bool autorename = false, bool forceAsync = false)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.String>	paths	List of paths to be created in the user's Dropbox. Duplicate path arguments in the batch are considered only once.
System.Boolean	autorename	If there's a conflict, have the Dropbox server try to autorename the folder to avoid the conflict.
System.Boolean	forceAsync	Whether to force the create to happen asynchronously.

Returns

Type	Description
System.Threading.Tasks.Task<CreateFolderBatchLaunch>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

CreateFolderBatchCheckAsync(PollArg)

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

Declaration

public Task<CreateFolderBatchJobStatus> CreateFolderBatchCheckAsync(PollArg pollArg)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<CreateFolderBatchJobStatus>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

CreateFolderBatchCheckAsync(String)

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

Declaration

public Task<CreateFolderBatchJobStatus> CreateFolderBatchCheckAsync(string asyncJobId)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Returns

Type	Description
System.Threading.Tasks.Task<CreateFolderBatchJobStatus>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

CreateFolderV2Async(CreateFolderArg)

Create a folder at a given path.

Declaration

public Task<CreateFolderResult> CreateFolderV2Async(CreateFolderArg createFolderArg)

Parameters

Type	Name	Description
CreateFolderArg	createFolderArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<CreateFolderResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a CreateFolderError.

CreateFolderV2Async(String, Boolean)

Create a folder at a given path.

Declaration

public Task<CreateFolderResult> CreateFolderV2Async(string path, bool autorename = false)

Parameters

Type	Name	Description
System.String	path	Path in the user's Dropbox to create.
System.Boolean	autorename	If there's a conflict, have the Dropbox server try to autorename the folder to avoid the conflict.

Returns

Type	Description
System.Threading.Tasks.Task<CreateFolderResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a CreateFolderError.

DeleteAsync(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.

Declaration

[Obsolete("This function is deprecated, please use DeleteV2Async instead.")]
public Task<Metadata> DeleteAsync(DeleteArg deleteArg)

Parameters

Type	Name	Description
DeleteArg	deleteArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<Metadata>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a DeleteError.

DeleteAsync(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.

Declaration

[Obsolete("This function is deprecated, please use DeleteV2Async instead.")]
public Task<Metadata> DeleteAsync(string path, string parentRev = null)

Parameters

Type	Name	Description
System.String	path	Path in the user's Dropbox to delete.
System.String	parentRev	Perform delete if given "rev" matches the existing file's latest "rev". This field does not support deleting a folder.

Returns

Type	Description
System.Threading.Tasks.Task<Metadata>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a DeleteError.

DeleteBatchAsync(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.

Declaration

public Task<DeleteBatchLaunch> DeleteBatchAsync(DeleteBatchArg deleteBatchArg)

Parameters

Type	Name	Description
DeleteBatchArg	deleteBatchArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<DeleteBatchLaunch>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

DeleteBatchAsync(IEnumerable<DeleteArg>)

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.

Declaration

public Task<DeleteBatchLaunch> DeleteBatchAsync(IEnumerable<DeleteArg> entries)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<DeleteArg>	entries	The entries

Returns

Type	Description
System.Threading.Tasks.Task<DeleteBatchLaunch>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

DeleteBatchCheckAsync(PollArg)

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

Declaration

public Task<DeleteBatchJobStatus> DeleteBatchCheckAsync(PollArg pollArg)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<DeleteBatchJobStatus>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

DeleteBatchCheckAsync(String)

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

Declaration

public Task<DeleteBatchJobStatus> DeleteBatchCheckAsync(string asyncJobId)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Returns

Type	Description
System.Threading.Tasks.Task<DeleteBatchJobStatus>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

DeleteV2Async(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.

Declaration

public Task<DeleteResult> DeleteV2Async(DeleteArg deleteArg)

Parameters

Type	Name	Description
DeleteArg	deleteArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<DeleteResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a DeleteError.

DeleteV2Async(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.

Declaration

public Task<DeleteResult> DeleteV2Async(string path, string parentRev = null)

Parameters

Type	Name	Description
System.String	path	Path in the user's Dropbox to delete.
System.String	parentRev	Perform delete if given "rev" matches the existing file's latest "rev". This field does not support deleting a folder.

Returns

Type	Description
System.Threading.Tasks.Task<DeleteResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a DeleteError.

DownloadAsync(DownloadArg)

Download a file from a user's Dropbox.

Declaration

public Task<IDownloadResponse<FileMetadata>> DownloadAsync(DownloadArg downloadArg)

Parameters

Type	Name	Description
DownloadArg	downloadArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<IDownloadResponse<FileMetadata>>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a DownloadError.

DownloadAsync(String, String)

Download a file from a user's Dropbox.

Declaration

public Task<IDownloadResponse<FileMetadata>> DownloadAsync(string path, string rev = null)

Parameters

Type	Name	Description
System.String	path	The path of the file to download.
System.String	rev	Please specify revision in path instead.

Returns

Type	Description
System.Threading.Tasks.Task<IDownloadResponse<FileMetadata>>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a DownloadError.

DownloadZipAsync(DownloadZipArg)

Download a folder from the user's Dropbox, as a zip file. The folder must be less than 20 GB in size and any single file within must be less than 4 GB in size. The resulting zip must have fewer than 10,000 total file and folder entries, including the top level folder. The input cannot be a single file.

Declaration

public Task<IDownloadResponse<DownloadZipResult>> DownloadZipAsync(DownloadZipArg downloadZipArg)

Parameters

Type	Name	Description
DownloadZipArg	downloadZipArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<IDownloadResponse<DownloadZipResult>>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a DownloadZipError.

DownloadZipAsync(String)

Download a folder from the user's Dropbox, as a zip file. The folder must be less than 20 GB in size and any single file within must be less than 4 GB in size. The resulting zip must have fewer than 10,000 total file and folder entries, including the top level folder. The input cannot be a single file.

Declaration

public Task<IDownloadResponse<DownloadZipResult>> DownloadZipAsync(string path)

Parameters

Type	Name	Description
System.String	path	The path of the folder to download.

Returns

Type	Description
System.Threading.Tasks.Task<IDownloadResponse<DownloadZipResult>>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a DownloadZipError.

EndAlphaGetMetadata(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated, please use EndGetMetadata instead.")]
public Metadata EndAlphaGetMetadata(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
Metadata	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a AlphaGetMetadataError.

EndAlphaUpload(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated, please use EndUpload instead.")]
public FileMetadata EndAlphaUpload(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
FileMetadata	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UploadError.

EndCopy(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated, please use EndCopyV2 instead.")]
public Metadata EndCopy(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
Metadata	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a RelocationError.

EndCopyBatch(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated, please use EndCopyBatchV2 instead.")]
public RelocationBatchLaunch EndCopyBatch(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
RelocationBatchLaunch	The response to the send request

EndCopyBatchCheck(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated, please use EndCopyBatchCheckV2 instead.")]
public RelocationBatchJobStatus EndCopyBatchCheck(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
RelocationBatchJobStatus	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

EndCopyBatchCheckV2(IAsyncResult)

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

Declaration

public RelocationBatchV2JobStatus EndCopyBatchCheckV2(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
RelocationBatchV2JobStatus	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

EndCopyBatchV2(IAsyncResult)

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

Declaration

public RelocationBatchV2Launch EndCopyBatchV2(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
RelocationBatchV2Launch	The response to the send request

EndCopyReferenceGet(IAsyncResult)

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

Declaration

public GetCopyReferenceResult EndCopyReferenceGet(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
GetCopyReferenceResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a GetCopyReferenceError.

EndCopyReferenceSave(IAsyncResult)

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

Declaration

public SaveCopyReferenceResult EndCopyReferenceSave(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
SaveCopyReferenceResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a SaveCopyReferenceError.

EndCopyV2(IAsyncResult)

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

Declaration

public RelocationResult EndCopyV2(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
RelocationResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a RelocationError.

EndCreateFolder(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated, please use EndCreateFolderV2 instead.")]
public FolderMetadata EndCreateFolder(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
FolderMetadata	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a CreateFolderError.

EndCreateFolderBatch(IAsyncResult)

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

Declaration

public CreateFolderBatchLaunch EndCreateFolderBatch(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
CreateFolderBatchLaunch	The response to the send request

EndCreateFolderBatchCheck(IAsyncResult)

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

Declaration

public CreateFolderBatchJobStatus EndCreateFolderBatchCheck(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
CreateFolderBatchJobStatus	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

EndCreateFolderV2(IAsyncResult)

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

Declaration

public CreateFolderResult EndCreateFolderV2(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
CreateFolderResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a CreateFolderError.

EndDelete(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated, please use EndDeleteV2 instead.")]
public Metadata EndDelete(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
Metadata	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a DeleteError.

EndDeleteBatch(IAsyncResult)

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

Declaration

public DeleteBatchLaunch EndDeleteBatch(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
DeleteBatchLaunch	The response to the send request

EndDeleteBatchCheck(IAsyncResult)

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

Declaration

public DeleteBatchJobStatus EndDeleteBatchCheck(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
DeleteBatchJobStatus	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

EndDeleteV2(IAsyncResult)

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

Declaration

public DeleteResult EndDeleteV2(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
DeleteResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a DeleteError.

EndDownload(IAsyncResult)

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

Declaration

public IDownloadResponse<FileMetadata> EndDownload(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
IDownloadResponse<FileMetadata>	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a DownloadError.

EndDownloadZip(IAsyncResult)

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

Declaration

public IDownloadResponse<DownloadZipResult> EndDownloadZip(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
IDownloadResponse<DownloadZipResult>	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a DownloadZipError.

EndExport(IAsyncResult)

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

Declaration

public IDownloadResponse<ExportResult> EndExport(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
IDownloadResponse<ExportResult>	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ExportError.

EndGetFileLockBatch(IAsyncResult)

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

Declaration

public LockFileBatchResult EndGetFileLockBatch(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
LockFileBatchResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a LockFileError.

EndGetMetadata(IAsyncResult)

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

Declaration

public Metadata EndGetMetadata(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
Metadata	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a GetMetadataError.

EndGetPreview(IAsyncResult)

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

Declaration

public IDownloadResponse<FileMetadata> EndGetPreview(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
IDownloadResponse<FileMetadata>	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PreviewError.

EndGetTemporaryLink(IAsyncResult)

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

Declaration

public GetTemporaryLinkResult EndGetTemporaryLink(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
GetTemporaryLinkResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a GetTemporaryLinkError.

EndGetTemporaryUploadLink(IAsyncResult)

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

Declaration

public GetTemporaryUploadLinkResult EndGetTemporaryUploadLink(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
GetTemporaryUploadLinkResult	The response to the send request

EndGetThumbnail(IAsyncResult)

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

Declaration

public IDownloadResponse<FileMetadata> EndGetThumbnail(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
IDownloadResponse<FileMetadata>	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ThumbnailError.

EndGetThumbnailBatch(IAsyncResult)

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

Declaration

public GetThumbnailBatchResult EndGetThumbnailBatch(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
GetThumbnailBatchResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a GetThumbnailBatchError.

EndGetThumbnailV2(IAsyncResult)

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

Declaration

public IDownloadResponse<PreviewResult> EndGetThumbnailV2(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
IDownloadResponse<PreviewResult>	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ThumbnailV2Error.

EndListFolder(IAsyncResult)

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

Declaration

public ListFolderResult EndListFolder(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
ListFolderResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ListFolderError.

EndListFolderContinue(IAsyncResult)

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

Declaration

public ListFolderResult EndListFolderContinue(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
ListFolderResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ListFolderContinueError.

EndListFolderGetLatestCursor(IAsyncResult)

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

Declaration

public ListFolderGetLatestCursorResult EndListFolderGetLatestCursor(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
ListFolderGetLatestCursorResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ListFolderError.

EndListFolderLongpoll(IAsyncResult)

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

Declaration

public ListFolderLongpollResult EndListFolderLongpoll(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
ListFolderLongpollResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ListFolderLongpollError.

EndListRevisions(IAsyncResult)

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

Declaration

public ListRevisionsResult EndListRevisions(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
ListRevisionsResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ListRevisionsError.

EndLockFileBatch(IAsyncResult)

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

Declaration

public LockFileBatchResult EndLockFileBatch(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
LockFileBatchResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a LockFileError.

EndMove(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated, please use EndMoveV2 instead.")]
public Metadata EndMove(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
Metadata	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a RelocationError.

EndMoveBatch(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated, please use EndMoveBatchV2 instead.")]
public RelocationBatchLaunch EndMoveBatch(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
RelocationBatchLaunch	The response to the send request

EndMoveBatchCheck(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated, please use EndMoveBatchCheckV2 instead.")]
public RelocationBatchJobStatus EndMoveBatchCheck(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
RelocationBatchJobStatus	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

EndMoveBatchCheckV2(IAsyncResult)

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

Declaration

public RelocationBatchV2JobStatus EndMoveBatchCheckV2(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
RelocationBatchV2JobStatus	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

EndMoveBatchV2(IAsyncResult)

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

Declaration

public RelocationBatchV2Launch EndMoveBatchV2(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
RelocationBatchV2Launch	The response to the send request

EndMoveV2(IAsyncResult)

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

Declaration

public RelocationResult EndMoveV2(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
RelocationResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a RelocationError.

EndPaperCreate(IAsyncResult)

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

Declaration

public PaperCreateResult EndPaperCreate(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
PaperCreateResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PaperCreateError.

EndPaperUpdate(IAsyncResult)

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

Declaration

public PaperUpdateResult EndPaperUpdate(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
PaperUpdateResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PaperUpdateError.

EndPermanentlyDelete(IAsyncResult)

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

Declaration

public void EndPermanentlyDelete(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a DeleteError.

EndPropertiesAdd(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated")]
public void EndPropertiesAdd(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a AddPropertiesError.

EndPropertiesOverwrite(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated")]
public void EndPropertiesOverwrite(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a InvalidPropertyGroupError.

EndPropertiesRemove(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated")]
public void EndPropertiesRemove(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a RemovePropertiesError.

EndPropertiesTemplateGet(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated")]
public GetTemplateResult EndPropertiesTemplateGet(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
GetTemplateResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a TemplateError.

EndPropertiesTemplateList(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated")]
public ListTemplateResult EndPropertiesTemplateList(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
ListTemplateResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a TemplateError.

EndPropertiesUpdate(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated")]
public void EndPropertiesUpdate(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UpdatePropertiesError.

EndRestore(IAsyncResult)

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

Declaration

public FileMetadata EndRestore(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
FileMetadata	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a RestoreError.

EndSaveUrl(IAsyncResult)

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

Declaration

public SaveUrlResult EndSaveUrl(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
SaveUrlResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a SaveUrlError.

EndSaveUrlCheckJobStatus(IAsyncResult)

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

Declaration

public SaveUrlJobStatus EndSaveUrlCheckJobStatus(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
SaveUrlJobStatus	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

EndSearch(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated, please use EndSearchV2 instead.")]
public SearchResult EndSearch(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
SearchResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a SearchError.

EndSearchContinueV2(IAsyncResult)

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

Declaration

public SearchV2Result EndSearchContinueV2(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
SearchV2Result	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a SearchError.

EndSearchV2(IAsyncResult)

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

Declaration

public SearchV2Result EndSearchV2(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
SearchV2Result	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a SearchError.

EndTagsAdd(IAsyncResult)

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

Declaration

public void EndTagsAdd(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a AddTagError.

EndTagsGet(IAsyncResult)

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

Declaration

public GetTagsResult EndTagsGet(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
GetTagsResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a BaseTagError.

EndTagsRemove(IAsyncResult)

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

Declaration

public void EndTagsRemove(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a RemoveTagError.

EndUnlockFileBatch(IAsyncResult)

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

Declaration

public LockFileBatchResult EndUnlockFileBatch(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
LockFileBatchResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a LockFileError.

EndUpload(IAsyncResult)

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

Declaration

public FileMetadata EndUpload(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
FileMetadata	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UploadError.

EndUploadSessionAppend(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated, please use EndUploadSessionAppendV2 instead.")]
public void EndUploadSessionAppend(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UploadSessionAppendError.

EndUploadSessionAppendV2(IAsyncResult)

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

Declaration

public void EndUploadSessionAppendV2(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UploadSessionAppendError.

EndUploadSessionFinish(IAsyncResult)

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

Declaration

public FileMetadata EndUploadSessionFinish(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
FileMetadata	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UploadSessionFinishError.

EndUploadSessionFinishBatch(IAsyncResult)

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

Declaration

[Obsolete("This function is deprecated, please use EndUploadSessionFinishBatchV2 instead.")]
public UploadSessionFinishBatchLaunch EndUploadSessionFinishBatch(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
UploadSessionFinishBatchLaunch	The response to the send request

EndUploadSessionFinishBatchCheck(IAsyncResult)

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

Declaration

public UploadSessionFinishBatchJobStatus EndUploadSessionFinishBatchCheck(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
UploadSessionFinishBatchJobStatus	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

EndUploadSessionFinishBatchV2(IAsyncResult)

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

Declaration

public UploadSessionFinishBatchResult EndUploadSessionFinishBatchV2(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
UploadSessionFinishBatchResult	The response to the send request

EndUploadSessionStart(IAsyncResult)

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

Declaration

public UploadSessionStartResult EndUploadSessionStart(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
UploadSessionStartResult	The response to the send request

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UploadSessionStartError.

EndUploadSessionStartBatch(IAsyncResult)

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

Declaration

public UploadSessionStartBatchResult EndUploadSessionStartBatch(IAsyncResult asyncResult)

Parameters

Type	Name	Description
System.IAsyncResult	asyncResult	The reference to the pending asynchronous send request

Returns

Type	Description
UploadSessionStartBatchResult	The response to the send request

ExportAsync(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.

Declaration

public Task<IDownloadResponse<ExportResult>> ExportAsync(ExportArg exportArg)

Parameters

Type	Name	Description
ExportArg	exportArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<IDownloadResponse<ExportResult>>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ExportError.

ExportAsync(String, 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.

Declaration

public Task<IDownloadResponse<ExportResult>> ExportAsync(string path, string exportFormat = null)

Parameters

Type	Name	Description
System.String	path	The path of the file to be exported.
System.String	exportFormat	The file format to which the file should be exported. This must be one of the formats listed in the file's export_options returned by GetMetadataAsync(GetMetadataArg). If none is specified, the default format (specified in export_as in file metadata) will be used.

Returns

Type	Description
System.Threading.Tasks.Task<IDownloadResponse<ExportResult>>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ExportError.

GetFileLockBatchAsync(LockFileBatchArg)

Return the lock metadata for the given list of paths.

Declaration

public Task<LockFileBatchResult> GetFileLockBatchAsync(LockFileBatchArg lockFileBatchArg)

Parameters

Type	Name	Description
LockFileBatchArg	lockFileBatchArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<LockFileBatchResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a LockFileError.

GetFileLockBatchAsync(IEnumerable<LockFileArg>)

Return the lock metadata for the given list of paths.

Declaration

public Task<LockFileBatchResult> GetFileLockBatchAsync(IEnumerable<LockFileArg> entries)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<LockFileArg>	entries	List of 'entries'. Each 'entry' contains a path of the file which will be locked or queried. Duplicate path arguments in the batch are considered only once.

Returns

Type	Description
System.Threading.Tasks.Task<LockFileBatchResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a LockFileError.

GetMetadataAsync(GetMetadataArg)

Returns the metadata for a file or folder.

Note: Metadata for the root folder is unsupported.

Declaration

public Task<Metadata> GetMetadataAsync(GetMetadataArg getMetadataArg)

Parameters

Type	Name	Description
GetMetadataArg	getMetadataArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<Metadata>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a GetMetadataError.

GetMetadataAsync(String, Boolean, Boolean, Boolean, TemplateFilterBase)

Returns the metadata for a file or folder.

Note: Metadata for the root folder is unsupported.

Declaration

public Task<Metadata> GetMetadataAsync(string path, bool includeMediaInfo = false, bool includeDeleted = false, bool includeHasExplicitSharedMembers = false, TemplateFilterBase includePropertyGroups = null)

Parameters

Type	Name	Description
System.String	path	The path of a file or folder on Dropbox.
System.Boolean	includeMediaInfo	If true, MediaInfo is set for photo and video.
System.Boolean	includeDeleted	If true, DeletedMetadata will be returned for deleted file or folder, otherwise LookupError.NotFound will be returned.
System.Boolean	includeHasExplicitSharedMembers	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
TemplateFilterBase	includePropertyGroups	If set to a valid list of template IDs, PropertyGroups is set if there exists property data associated with the file and each of the listed templates.

Returns

Type	Description
System.Threading.Tasks.Task<Metadata>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a GetMetadataError.

GetPreviewAsync(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.

Declaration

public Task<IDownloadResponse<FileMetadata>> GetPreviewAsync(PreviewArg previewArg)

Parameters

Type	Name	Description
PreviewArg	previewArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<IDownloadResponse<FileMetadata>>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PreviewError.

GetPreviewAsync(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.

Declaration

public Task<IDownloadResponse<FileMetadata>> GetPreviewAsync(string path, string rev = null)

Parameters

Type	Name	Description
System.String	path	The path of the file to preview.
System.String	rev	Please specify revision in path instead.

Returns

Type	Description
System.Threading.Tasks.Task<IDownloadResponse<FileMetadata>>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PreviewError.

GetTemporaryLinkAsync(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.

Declaration

public Task<GetTemporaryLinkResult> GetTemporaryLinkAsync(GetTemporaryLinkArg getTemporaryLinkArg)

Parameters

Type	Name	Description
GetTemporaryLinkArg	getTemporaryLinkArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<GetTemporaryLinkResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a GetTemporaryLinkError.

GetTemporaryLinkAsync(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.

Declaration

public Task<GetTemporaryLinkResult> GetTemporaryLinkAsync(string path)

Parameters

Type	Name	Description
System.String	path	The path to the file you want a temporary link to.

Returns

Type	Description
System.Threading.Tasks.Task<GetTemporaryLinkResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a GetTemporaryLinkError.

GetTemporaryUploadLinkAsync(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(UploadArg, 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 successful 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.

Declaration

public Task<GetTemporaryUploadLinkResult> GetTemporaryUploadLinkAsync(CommitInfo commitInfo, double duration = 14400)

Parameters

Type	Name	Description
CommitInfo	commitInfo	Contains the path and other optional modifiers for the future upload commit. Equivalent to the parameters provided to UploadAsync(UploadArg, Stream).
System.Double	duration	How long before this link expires, in seconds. Attempting to start an upload with this link longer than this period of time after link creation will result in an error.

Returns

Type	Description
System.Threading.Tasks.Task<GetTemporaryUploadLinkResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

GetTemporaryUploadLinkAsync(GetTemporaryUploadLinkArg)

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

This endpoint acts as a delayed UploadAsync(UploadArg, 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 successful 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.

Declaration

public Task<GetTemporaryUploadLinkResult> GetTemporaryUploadLinkAsync(GetTemporaryUploadLinkArg getTemporaryUploadLinkArg)

Parameters

Type	Name	Description
GetTemporaryUploadLinkArg	getTemporaryUploadLinkArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<GetTemporaryUploadLinkResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

GetThumbnailAsync(ThumbnailArg)

Get a thumbnail for an image.

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

Declaration

public Task<IDownloadResponse<FileMetadata>> GetThumbnailAsync(ThumbnailArg thumbnailArg)

Parameters

Type	Name	Description
ThumbnailArg	thumbnailArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<IDownloadResponse<FileMetadata>>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ThumbnailError.

GetThumbnailAsync(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, webp, ppm and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail.

Declaration

public Task<IDownloadResponse<FileMetadata>> GetThumbnailAsync(string path, ThumbnailFormat format = null, ThumbnailSize size = null, ThumbnailMode mode = null)

Parameters

Type	Name	Description
System.String	path	The path to the image file you want to thumbnail.
ThumbnailFormat	format	The format for the thumbnail image, jpeg (default) or png. For images that are photos, jpeg should be preferred, while png is better for screenshots and digital arts.
ThumbnailSize	size	The size for the thumbnail image.
ThumbnailMode	mode	How to resize and crop the image to achieve the desired size.

Returns

Type	Description
System.Threading.Tasks.Task<IDownloadResponse<FileMetadata>>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ThumbnailError.

GetThumbnailBatchAsync(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, webp, ppm and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail.

Declaration

public Task<GetThumbnailBatchResult> GetThumbnailBatchAsync(GetThumbnailBatchArg getThumbnailBatchArg)

Parameters

Type	Name	Description
GetThumbnailBatchArg	getThumbnailBatchArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<GetThumbnailBatchResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a GetThumbnailBatchError.

GetThumbnailBatchAsync(IEnumerable<ThumbnailArg>)

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, webp, ppm and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail.

Declaration

public Task<GetThumbnailBatchResult> GetThumbnailBatchAsync(IEnumerable<ThumbnailArg> entries)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<ThumbnailArg>	entries	List of files to get thumbnails.

Returns

Type	Description
System.Threading.Tasks.Task<GetThumbnailBatchResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a GetThumbnailBatchError.

GetThumbnailV2Async(PathOrLink, 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, webp, ppm and bmp. Photos that are larger than 20MB in size won't be converted to a thumbnail.

Declaration

public Task<IDownloadResponse<PreviewResult>> GetThumbnailV2Async(PathOrLink resource, ThumbnailFormat format = null, ThumbnailSize size = null, ThumbnailMode mode = null)

Parameters

Type	Name	Description
PathOrLink	resource	Information specifying which file to preview. This could be a path to a file, a shared link pointing to a file, or a shared link pointing to a folder, with a relative path.
ThumbnailFormat	format	The format for the thumbnail image, jpeg (default) or png. For images that are photos, jpeg should be preferred, while png is better for screenshots and digital arts.
ThumbnailSize	size	The size for the thumbnail image.
ThumbnailMode	mode	How to resize and crop the image to achieve the desired size.

Returns

Type	Description
System.Threading.Tasks.Task<IDownloadResponse<PreviewResult>>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ThumbnailV2Error.

GetThumbnailV2Async(ThumbnailV2Arg)

Get a thumbnail for an image.

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

Declaration

public Task<IDownloadResponse<PreviewResult>> GetThumbnailV2Async(ThumbnailV2Arg thumbnailV2Arg)

Parameters

Type	Name	Description
ThumbnailV2Arg	thumbnailV2Arg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<IDownloadResponse<PreviewResult>>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ThumbnailV2Error.

ListFolderAsync(ListFolderArg)

Starts returning the contents of a folder. If the result's HasMore field is true, call ListFolderContinueAsync(ListFolderContinueArg) 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 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) ListFolderAsync(ListFolderArg) or ListFolderContinueAsync(ListFolderContinueArg) 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.

Declaration

public Task<ListFolderResult> ListFolderAsync(ListFolderArg listFolderArg)

Parameters

Type	Name	Description
ListFolderArg	listFolderArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<ListFolderResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ListFolderError.

ListFolderAsync(String, Boolean, Boolean, Boolean, Boolean, Boolean, Nullable<UInt32>, SharedLink, TemplateFilterBase, Boolean)

Starts returning the contents of a folder. If the result's HasMore field is true, call ListFolderContinueAsync(ListFolderContinueArg) 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 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) ListFolderAsync(ListFolderArg) or ListFolderContinueAsync(ListFolderContinueArg) 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.

Declaration

public Task<ListFolderResult> ListFolderAsync(string path, bool recursive = false, bool includeMediaInfo = false, bool includeDeleted = false, bool includeHasExplicitSharedMembers = false, bool includeMountedFolders = true, uint? limit = null, SharedLink sharedLink = null, TemplateFilterBase includePropertyGroups = null, bool includeNonDownloadableFiles = true)

Parameters

Type	Name	Description
System.String	path	A unique identifier for the file.
System.Boolean	recursive	If true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders.
System.Boolean	includeMediaInfo	If true, MediaInfo is set for photo and video. This parameter will no longer have an effect starting December 2, 2019.
System.Boolean	includeDeleted	If true, the results will include entries for files and folders that used to exist but were deleted.
System.Boolean	includeHasExplicitSharedMembers	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
System.Boolean	includeMountedFolders	If true, the results will include entries under mounted folders which includes app folder, shared folder and team folder.
System.Nullable<System.UInt32>	limit	The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases.
SharedLink	sharedLink	A shared link to list the contents of. If the link is password-protected, the password must be provided. If this field is present, Path will be relative to root of the shared link. Only non-recursive mode is supported for shared link.
TemplateFilterBase	includePropertyGroups	If set to a valid list of template IDs, PropertyGroups is set if there exists property data associated with the file and each of the listed templates.
System.Boolean	includeNonDownloadableFiles	If true, include files that are not downloadable, i.e. Google Docs.

Returns

Type	Description
System.Threading.Tasks.Task<ListFolderResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ListFolderError.

ListFolderContinueAsync(ListFolderContinueArg)

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

Declaration

public Task<ListFolderResult> ListFolderContinueAsync(ListFolderContinueArg listFolderContinueArg)

Parameters

Type	Name	Description
ListFolderContinueArg	listFolderContinueArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<ListFolderResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ListFolderContinueError.

ListFolderContinueAsync(String)

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

Declaration

public Task<ListFolderResult> ListFolderContinueAsync(string cursor)

Parameters

Type	Name	Description
System.String	cursor	The cursor returned by your last call to ListFolderAsync(ListFolderArg) ListFolderAsync(ListFolderArg) or ListFolderContinueAsync(ListFolderContinueArg) ListFolderContinueAsync(ListFolderContinueArg).

Returns

Type	Description
System.Threading.Tasks.Task<ListFolderResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ListFolderContinueError.

ListFolderGetLatestCursorAsync(ListFolderArg)

A way to quickly get a cursor for the folder's state. Unlike ListFolderAsync(ListFolderArg) 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.

Declaration

public Task<ListFolderGetLatestCursorResult> ListFolderGetLatestCursorAsync(ListFolderArg listFolderArg)

Parameters

Type	Name	Description
ListFolderArg	listFolderArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<ListFolderGetLatestCursorResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ListFolderError.

ListFolderGetLatestCursorAsync(String, Boolean, Boolean, Boolean, Boolean, Boolean, Nullable<UInt32>, SharedLink, TemplateFilterBase, Boolean)

A way to quickly get a cursor for the folder's state. Unlike ListFolderAsync(ListFolderArg) 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.

Declaration

public Task<ListFolderGetLatestCursorResult> ListFolderGetLatestCursorAsync(string path, bool recursive = false, bool includeMediaInfo = false, bool includeDeleted = false, bool includeHasExplicitSharedMembers = false, bool includeMountedFolders = true, uint? limit = null, SharedLink sharedLink = null, TemplateFilterBase includePropertyGroups = null, bool includeNonDownloadableFiles = true)

Parameters

Type	Name	Description
System.String	path	A unique identifier for the file.
System.Boolean	recursive	If true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders.
System.Boolean	includeMediaInfo	If true, MediaInfo is set for photo and video. This parameter will no longer have an effect starting December 2, 2019.
System.Boolean	includeDeleted	If true, the results will include entries for files and folders that used to exist but were deleted.
System.Boolean	includeHasExplicitSharedMembers	If true, the results will include a flag for each file indicating whether or not that file has any explicit members.
System.Boolean	includeMountedFolders	If true, the results will include entries under mounted folders which includes app folder, shared folder and team folder.
System.Nullable<System.UInt32>	limit	The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases.
SharedLink	sharedLink	A shared link to list the contents of. If the link is password-protected, the password must be provided. If this field is present, Path will be relative to root of the shared link. Only non-recursive mode is supported for shared link.
TemplateFilterBase	includePropertyGroups	If set to a valid list of template IDs, PropertyGroups is set if there exists property data associated with the file and each of the listed templates.
System.Boolean	includeNonDownloadableFiles	If true, include files that are not downloadable, i.e. Google Docs.

Returns

Type	Description
System.Threading.Tasks.Task<ListFolderGetLatestCursorResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ListFolderError.

ListFolderLongpollAsync(ListFolderLongpollArg)

A longpoll endpoint to wait for changes on an account. In conjunction with ListFolderContinueAsync(ListFolderContinueArg) 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.

Declaration

public Task<ListFolderLongpollResult> ListFolderLongpollAsync(ListFolderLongpollArg listFolderLongpollArg)

Parameters

Type	Name	Description
ListFolderLongpollArg	listFolderLongpollArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<ListFolderLongpollResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ListFolderLongpollError.

ListFolderLongpollAsync(String, UInt64)

A longpoll endpoint to wait for changes on an account. In conjunction with ListFolderContinueAsync(ListFolderContinueArg) 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.

Declaration

public Task<ListFolderLongpollResult> ListFolderLongpollAsync(string cursor, ulong timeout = 30UL)

Parameters

Type	Name	Description
System.String	cursor	A cursor as returned by ListFolderAsync(ListFolderArg) ListFolderAsync(ListFolderArg) or ListFolderContinueAsync(ListFolderContinueArg) ListFolderContinueAsync(ListFolderContinueArg). Cursors retrieved by setting IncludeMediaInfo to true are not supported.
System.UInt64	timeout	A timeout in seconds. The request will block for at most this length of time, plus up to 90 seconds of random jitter added to avoid the thundering herd problem. Care should be taken when using this parameter, as some network infrastructure does not support long timeouts.

Returns

Type	Description
System.Threading.Tasks.Task<ListFolderLongpollResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ListFolderLongpollError.

ListRevisionsAsync(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 ListRevisionsMode.Path (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 ListRevisionsMode.Id. The ListRevisionsMode.Id mode is useful to retrieve revisions for a given file across moves or renames.

Declaration

public Task<ListRevisionsResult> ListRevisionsAsync(ListRevisionsArg listRevisionsArg)

Parameters

Type	Name	Description
ListRevisionsArg	listRevisionsArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<ListRevisionsResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ListRevisionsError.

ListRevisionsAsync(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 ListRevisionsMode.Path (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 ListRevisionsMode.Id. The ListRevisionsMode.Id mode is useful to retrieve revisions for a given file across moves or renames.

Declaration

public Task<ListRevisionsResult> ListRevisionsAsync(string path, ListRevisionsMode mode = null, ulong limit = 10UL)

Parameters

Type	Name	Description
System.String	path	The path to the file you want to see the revisions of.
ListRevisionsMode	mode	Determines the behavior of the API in listing the revisions for a given file path or id.
System.UInt64	limit	The maximum number of revision entries returned.

Returns

Type	Description
System.Threading.Tasks.Task<ListRevisionsResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a ListRevisionsError.

LockFileBatchAsync(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.

Declaration

public Task<LockFileBatchResult> LockFileBatchAsync(LockFileBatchArg lockFileBatchArg)

Parameters

Type	Name	Description
LockFileBatchArg	lockFileBatchArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<LockFileBatchResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a LockFileError.

LockFileBatchAsync(IEnumerable<LockFileArg>)

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.

Declaration

public Task<LockFileBatchResult> LockFileBatchAsync(IEnumerable<LockFileArg> entries)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<LockFileArg>	entries	List of 'entries'. Each 'entry' contains a path of the file which will be locked or queried. Duplicate path arguments in the batch are considered only once.

Returns

Type	Description
System.Threading.Tasks.Task<LockFileBatchResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a LockFileError.

MoveAsync(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.

Declaration

[Obsolete("This function is deprecated, please use MoveV2Async instead.")]
public Task<Metadata> MoveAsync(RelocationArg relocationArg)

Parameters

Type	Name	Description
RelocationArg	relocationArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<Metadata>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a RelocationError.

MoveAsync(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.

Declaration

[Obsolete("This function is deprecated, please use MoveV2Async instead.")]
public Task<Metadata> MoveAsync(string fromPath, string toPath, bool allowSharedFolder = false, bool autorename = false, bool allowOwnershipTransfer = false)

Parameters

Type	Name	Description
System.String	fromPath	Path in the user's Dropbox to be copied or moved.
System.String	toPath	Path in the user's Dropbox that is the destination.
System.Boolean	allowSharedFolder	This flag has no effect.
System.Boolean	autorename	If there's a conflict, have the Dropbox server try to autorename the file to avoid the conflict.
System.Boolean	allowOwnershipTransfer	Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.

Returns

Type	Description
System.Threading.Tasks.Task<Metadata>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a RelocationError.

MoveBatchAsync(RelocationBatchArg)

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.

Declaration

[Obsolete("This function is deprecated, please use MoveBatchV2Async instead.")]
public Task<RelocationBatchLaunch> MoveBatchAsync(RelocationBatchArg relocationBatchArg)

Parameters

Type	Name	Description
RelocationBatchArg	relocationBatchArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<RelocationBatchLaunch>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

MoveBatchAsync(IEnumerable<RelocationPath>, Boolean, Boolean, Boolean)

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.

Declaration

[Obsolete("This function is deprecated, please use MoveBatchV2Async instead.")]
public Task<RelocationBatchLaunch> MoveBatchAsync(IEnumerable<RelocationPath> entries, bool autorename = false, bool allowSharedFolder = false, bool allowOwnershipTransfer = false)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<RelocationPath>	entries	List of entries to be moved or copied. Each entry is RelocationPath.
System.Boolean	autorename	If there's a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict.
System.Boolean	allowSharedFolder	This flag has no effect.
System.Boolean	allowOwnershipTransfer	Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.

Returns

Type	Description
System.Threading.Tasks.Task<RelocationBatchLaunch>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

MoveBatchCheckAsync(PollArg)

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

Declaration

[Obsolete("This function is deprecated, please use MoveBatchCheckV2Async instead.")]
public Task<RelocationBatchJobStatus> MoveBatchCheckAsync(PollArg pollArg)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<RelocationBatchJobStatus>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

MoveBatchCheckAsync(String)

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

Declaration

[Obsolete("This function is deprecated, please use MoveBatchCheckV2Async instead.")]
public Task<RelocationBatchJobStatus> MoveBatchCheckAsync(string asyncJobId)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Returns

Type	Description
System.Threading.Tasks.Task<RelocationBatchJobStatus>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

MoveBatchCheckV2Async(PollArg)

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

Declaration

public Task<RelocationBatchV2JobStatus> MoveBatchCheckV2Async(PollArg pollArg)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<RelocationBatchV2JobStatus>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

MoveBatchCheckV2Async(String)

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

Declaration

public Task<RelocationBatchV2JobStatus> MoveBatchCheckV2Async(string asyncJobId)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Returns

Type	Description
System.Threading.Tasks.Task<RelocationBatchV2JobStatus>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

MoveBatchV2Async(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.

Declaration

public Task<RelocationBatchV2Launch> MoveBatchV2Async(MoveBatchArg moveBatchArg)

Parameters

Type	Name	Description
MoveBatchArg	moveBatchArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<RelocationBatchV2Launch>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

MoveBatchV2Async(IEnumerable<RelocationPath>, 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.

Declaration

public Task<RelocationBatchV2Launch> MoveBatchV2Async(IEnumerable<RelocationPath> entries, bool autorename = false, bool allowOwnershipTransfer = false)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<RelocationPath>	entries	List of entries to be moved or copied. Each entry is RelocationPath.
System.Boolean	autorename	If there's a conflict with any file, have the Dropbox server try to autorename that file to avoid the conflict.
System.Boolean	allowOwnershipTransfer	Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.

Returns

Type	Description
System.Threading.Tasks.Task<RelocationBatchV2Launch>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

MoveV2Async(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.

Declaration

public Task<RelocationResult> MoveV2Async(RelocationArg relocationArg)

Parameters

Type	Name	Description
RelocationArg	relocationArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<RelocationResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a RelocationError.

MoveV2Async(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.

Declaration

public Task<RelocationResult> MoveV2Async(string fromPath, string toPath, bool allowSharedFolder = false, bool autorename = false, bool allowOwnershipTransfer = false)

Parameters

Type	Name	Description
System.String	fromPath	Path in the user's Dropbox to be copied or moved.
System.String	toPath	Path in the user's Dropbox that is the destination.
System.Boolean	allowSharedFolder	This flag has no effect.
System.Boolean	autorename	If there's a conflict, have the Dropbox server try to autorename the file to avoid the conflict.
System.Boolean	allowOwnershipTransfer	Allow moves by owner even if it would result in an ownership transfer for the content being moved. This does not apply to copies.

Returns

Type	Description
System.Threading.Tasks.Task<RelocationResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a RelocationError.

PaperCreateAsync(PaperCreateArg, Stream)

Creates a new Paper doc with the provided content.

Declaration

public Task<PaperCreateResult> PaperCreateAsync(PaperCreateArg paperCreateArg, Stream body)

Parameters

Type	Name	Description
PaperCreateArg	paperCreateArg	The request parameters
System.IO.Stream	body	The content to upload.

Returns

Type	Description
System.Threading.Tasks.Task<PaperCreateResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PaperCreateError.

PaperCreateAsync(String, ImportFormat, Stream)

Creates a new Paper doc with the provided content.

Declaration

public Task<PaperCreateResult> PaperCreateAsync(string path, ImportFormat importFormat, Stream body)

Parameters

Type	Name	Description
System.String	path	The fully qualified path to the location in the user's Dropbox where the Paper Doc should be created. This should include the document's title and end with .paper.
ImportFormat	importFormat	The format of the provided data.
System.IO.Stream	body	The document to upload

Returns

Type	Description
System.Threading.Tasks.Task<PaperCreateResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PaperCreateError.

PaperUpdateAsync(PaperUpdateArg, Stream)

Updates an existing Paper doc with the provided content.

Declaration

public Task<PaperUpdateResult> PaperUpdateAsync(PaperUpdateArg paperUpdateArg, Stream body)

Parameters

Type	Name	Description
PaperUpdateArg	paperUpdateArg	The request parameters
System.IO.Stream	body	The content to upload.

Returns

Type	Description
System.Threading.Tasks.Task<PaperUpdateResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PaperUpdateError.

PaperUpdateAsync(String, ImportFormat, PaperDocUpdatePolicy, Nullable<Int64>, Stream)

Updates an existing Paper doc with the provided content.

Declaration

public Task<PaperUpdateResult> PaperUpdateAsync(string path, ImportFormat importFormat, PaperDocUpdatePolicy docUpdatePolicy, long? paperRevision = null, Stream body = null)

Parameters

Type	Name	Description
System.String	path	Path in the user's Dropbox to update. The path must correspond to a Paper doc or an error will be returned.
ImportFormat	importFormat	The format of the provided data.
PaperDocUpdatePolicy	docUpdatePolicy	How the provided content should be applied to the doc.
System.Nullable<System.Int64>	paperRevision	The latest doc revision. Required when doc_update_policy is update. This value must match the current revision of the doc or error revision_mismatch will be returned.
System.IO.Stream	body	The document to upload

Returns

Type	Description
System.Threading.Tasks.Task<PaperUpdateResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PaperUpdateError.

PermanentlyDeleteAsync(DeleteArg)

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

If the given file or folder is not yet deleted, this route will first delete it. It is possible for this route to successfully delete, then fail to permanently delete.

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

Declaration

public Task PermanentlyDeleteAsync(DeleteArg deleteArg)

Parameters

Type	Name	Description
DeleteArg	deleteArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task	The task that represents the asynchronous send operation.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a DeleteError.

PermanentlyDeleteAsync(String, String)

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

If the given file or folder is not yet deleted, this route will first delete it. It is possible for this route to successfully delete, then fail to permanently delete.

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

Declaration

public Task PermanentlyDeleteAsync(string path, string parentRev = null)

Parameters

Type	Name	Description
System.String	path	Path in the user's Dropbox to delete.
System.String	parentRev	Perform delete if given "rev" matches the existing file's latest "rev". This field does not support deleting a folder.

Returns

Type	Description
System.Threading.Tasks.Task	The task that represents the asynchronous send operation.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a DeleteError.

PropertiesAddAsync(AddPropertiesArg)

The properties add route

Declaration

[Obsolete("This function is deprecated")]
public Task PropertiesAddAsync(AddPropertiesArg addPropertiesArg)

Parameters

Type	Name	Description
AddPropertiesArg	addPropertiesArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task	The task that represents the asynchronous send operation.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a AddPropertiesError.

PropertiesAddAsync(String, IEnumerable<PropertyGroup>)

The properties add route

Declaration

[Obsolete("This function is deprecated")]
public Task PropertiesAddAsync(string path, IEnumerable<PropertyGroup> propertyGroups)

Parameters

Type	Name	Description
System.String	path	A unique identifier for the file or folder.
System.Collections.Generic.IEnumerable<PropertyGroup>	propertyGroups	The property groups which are to be added to a Dropbox file. No two groups in the input should refer to the same template.

Returns

Type	Description
System.Threading.Tasks.Task	The task that represents the asynchronous send operation.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a AddPropertiesError.

PropertiesOverwriteAsync(OverwritePropertyGroupArg)

The properties overwrite route

Declaration

[Obsolete("This function is deprecated")]
public Task PropertiesOverwriteAsync(OverwritePropertyGroupArg overwritePropertyGroupArg)

Parameters

Type	Name	Description
OverwritePropertyGroupArg	overwritePropertyGroupArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task	The task that represents the asynchronous send operation.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a InvalidPropertyGroupError.

PropertiesOverwriteAsync(String, IEnumerable<PropertyGroup>)

The properties overwrite route

Declaration

[Obsolete("This function is deprecated")]
public Task PropertiesOverwriteAsync(string path, IEnumerable<PropertyGroup> propertyGroups)

Parameters

Type	Name	Description
System.String	path	A unique identifier for the file or folder.
System.Collections.Generic.IEnumerable<PropertyGroup>	propertyGroups	The property groups "snapshot" updates to force apply. No two groups in the input should refer to the same template.

Returns

Type	Description
System.Threading.Tasks.Task	The task that represents the asynchronous send operation.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a InvalidPropertyGroupError.

PropertiesRemoveAsync(RemovePropertiesArg)

The properties remove route

Declaration

[Obsolete("This function is deprecated")]
public Task PropertiesRemoveAsync(RemovePropertiesArg removePropertiesArg)

Parameters

Type	Name	Description
RemovePropertiesArg	removePropertiesArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task	The task that represents the asynchronous send operation.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a RemovePropertiesError.

PropertiesRemoveAsync(String, IEnumerable<String>)

The properties remove route

Declaration

[Obsolete("This function is deprecated")]
public Task PropertiesRemoveAsync(string path, IEnumerable<string> propertyTemplateIds)

Parameters

Type	Name	Description
System.String	path	A unique identifier for the file or folder.
System.Collections.Generic.IEnumerable<System.String>	propertyTemplateIds	A list of identifiers for a template created by TemplatesAddForUserAsync(AddTemplateArg) or TemplatesAddForTeamAsync(AddTemplateArg).

Returns

Type	Description
System.Threading.Tasks.Task	The task that represents the asynchronous send operation.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a RemovePropertiesError.

PropertiesTemplateGetAsync(GetTemplateArg)

The properties template get route

Declaration

[Obsolete("This function is deprecated")]
public Task<GetTemplateResult> PropertiesTemplateGetAsync(GetTemplateArg getTemplateArg)

Parameters

Type	Name	Description
GetTemplateArg	getTemplateArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<GetTemplateResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a TemplateError.

PropertiesTemplateGetAsync(String)

The properties template get route

Declaration

[Obsolete("This function is deprecated")]
public Task<GetTemplateResult> PropertiesTemplateGetAsync(string templateId)

Parameters

Type	Name	Description
System.String	templateId	An identifier for template added by route See TemplatesAddForUserAsync(AddTemplateArg) or TemplatesAddForTeamAsync(AddTemplateArg).

Returns

Type	Description
System.Threading.Tasks.Task<GetTemplateResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a TemplateError.

PropertiesTemplateListAsync()

The properties template list route

Declaration

[Obsolete("This function is deprecated")]
public Task<ListTemplateResult> PropertiesTemplateListAsync()

Returns

Type	Description
System.Threading.Tasks.Task<ListTemplateResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a TemplateError.

PropertiesUpdateAsync(UpdatePropertiesArg)

The properties update route

Declaration

[Obsolete("This function is deprecated")]
public Task PropertiesUpdateAsync(UpdatePropertiesArg updatePropertiesArg)

Parameters

Type	Name	Description
UpdatePropertiesArg	updatePropertiesArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task	The task that represents the asynchronous send operation.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UpdatePropertiesError.

PropertiesUpdateAsync(String, IEnumerable<PropertyGroupUpdate>)

The properties update route

Declaration

[Obsolete("This function is deprecated")]
public Task PropertiesUpdateAsync(string path, IEnumerable<PropertyGroupUpdate> updatePropertyGroups)

Parameters

Type	Name	Description
System.String	path	A unique identifier for the file or folder.
System.Collections.Generic.IEnumerable<PropertyGroupUpdate>	updatePropertyGroups	The property groups "delta" updates to apply.

Returns

Type	Description
System.Threading.Tasks.Task	The task that represents the asynchronous send operation.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UpdatePropertiesError.

RestoreAsync(RestoreArg)

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

Declaration

public Task<FileMetadata> RestoreAsync(RestoreArg restoreArg)

Parameters

Type	Name	Description
RestoreArg	restoreArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<FileMetadata>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a RestoreError.

RestoreAsync(String, String)

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

Declaration

public Task<FileMetadata> RestoreAsync(string path, string rev)

Parameters

Type	Name	Description
System.String	path	The path to save the restored file.
System.String	rev	The revision to restore.

Returns

Type	Description
System.Threading.Tasks.Task<FileMetadata>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a RestoreError.

SaveUrlAsync(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).

Declaration

public Task<SaveUrlResult> SaveUrlAsync(SaveUrlArg saveUrlArg)

Parameters

Type	Name	Description
SaveUrlArg	saveUrlArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<SaveUrlResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a SaveUrlError.

SaveUrlAsync(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).

Declaration

public Task<SaveUrlResult> SaveUrlAsync(string path, string url)

Parameters

Type	Name	Description
System.String	path	The path in Dropbox where the URL will be saved to.
System.String	url	The URL to be saved.

Returns

Type	Description
System.Threading.Tasks.Task<SaveUrlResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a SaveUrlError.

SaveUrlCheckJobStatusAsync(PollArg)

Check the status of a SaveUrlAsync(SaveUrlArg) job.

Declaration

public Task<SaveUrlJobStatus> SaveUrlCheckJobStatusAsync(PollArg pollArg)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<SaveUrlJobStatus>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

SaveUrlCheckJobStatusAsync(String)

Check the status of a SaveUrlAsync(SaveUrlArg) job.

Declaration

public Task<SaveUrlJobStatus> SaveUrlCheckJobStatusAsync(string asyncJobId)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Returns

Type	Description
System.Threading.Tasks.Task<SaveUrlJobStatus>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

SearchAsync(SearchArg)

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.

Declaration

[Obsolete("This function is deprecated, please use SearchV2Async instead.")]
public Task<SearchResult> SearchAsync(SearchArg searchArg)

Parameters

Type	Name	Description
SearchArg	searchArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<SearchResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a SearchError.

SearchAsync(String, String, UInt64, UInt64, SearchMode)

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.

Declaration

[Obsolete("This function is deprecated, please use SearchV2Async instead.")]
public Task<SearchResult> SearchAsync(string path, string query, ulong start = 0UL, ulong maxResults = 100UL, SearchMode mode = null)

Parameters

Type	Name	Description
System.String	path	The path in the user's Dropbox to search. Should probably be a folder.
System.String	query	The string to search for. Query string may be rewritten to improve relevance of results. The string is split on spaces into multiple tokens. For file name searching, the last token is used for prefix matching (i.e. "bat c" matches "bat cave" but not "batman car").
System.UInt64	start	The starting index within the search results (used for paging).
System.UInt64	maxResults	The maximum number of search results to return.
SearchMode	mode	The search mode (filename, filename_and_content, or deleted_filename). Note that searching file content is only available for Dropbox Business accounts.

Returns

Type	Description
System.Threading.Tasks.Task<SearchResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a SearchError.

SearchContinueV2Async(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.

Declaration

public Task<SearchV2Result> SearchContinueV2Async(SearchV2ContinueArg searchV2ContinueArg)

Parameters

Type	Name	Description
SearchV2ContinueArg	searchV2ContinueArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<SearchV2Result>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a SearchError.

SearchContinueV2Async(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.

Declaration

public Task<SearchV2Result> SearchContinueV2Async(string cursor)

Parameters

Type	Name	Description
System.String	cursor	The cursor returned by your last call to SearchV2Async(SearchV2Arg). Used to fetch the next page of results.

Returns

Type	Description
System.Threading.Tasks.Task<SearchV2Result>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a SearchError.

SearchV2Async(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.

Declaration

public Task<SearchV2Result> SearchV2Async(SearchV2Arg searchV2Arg)

Parameters

Type	Name	Description
SearchV2Arg	searchV2Arg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<SearchV2Result>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a SearchError.

SearchV2Async(String, SearchOptions, SearchMatchFieldOptions, Nullable<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.

Declaration

public Task<SearchV2Result> SearchV2Async(string query, SearchOptions options = null, SearchMatchFieldOptions matchFieldOptions = null, bool? includeHighlights = null)

Parameters

Type	Name	Description
System.String	query	The string to search for. May match across multiple fields based on the request arguments.
SearchOptions	options	Options for more targeted search results.
SearchMatchFieldOptions	matchFieldOptions	Options for search results match fields.
System.Nullable<System.Boolean>	includeHighlights	Deprecated and moved this option to SearchMatchFieldOptions.

Returns

Type	Description
System.Threading.Tasks.Task<SearchV2Result>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a SearchError.

TagsAddAsync(AddTagArg)

Add a tag to an item. A tag is a string. The strings are automatically converted to lowercase letters. No more than 20 tags can be added to a given item.

Declaration

public Task TagsAddAsync(AddTagArg addTagArg)

Parameters

Type	Name	Description
AddTagArg	addTagArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task	The task that represents the asynchronous send operation.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a AddTagError.

TagsAddAsync(String, String)

Add a tag to an item. A tag is a string. The strings are automatically converted to lowercase letters. No more than 20 tags can be added to a given item.

Declaration

public Task TagsAddAsync(string path, string tagText)

Parameters

Type	Name	Description
System.String	path	Path to the item to be tagged.
System.String	tagText	The value of the tag to add.

Returns

Type	Description
System.Threading.Tasks.Task	The task that represents the asynchronous send operation.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a AddTagError.

TagsGetAsync(GetTagsArg)

Get list of tags assigned to items.

Declaration

public Task<GetTagsResult> TagsGetAsync(GetTagsArg getTagsArg)

Parameters

Type	Name	Description
GetTagsArg	getTagsArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<GetTagsResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a BaseTagError.

TagsGetAsync(IEnumerable<String>)

Get list of tags assigned to items.

Declaration

public Task<GetTagsResult> TagsGetAsync(IEnumerable<string> paths)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.String>	paths	Path to the items.

Returns

Type	Description
System.Threading.Tasks.Task<GetTagsResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a BaseTagError.

TagsRemoveAsync(RemoveTagArg)

Remove a tag from an item.

Declaration

public Task TagsRemoveAsync(RemoveTagArg removeTagArg)

Parameters

Type	Name	Description
RemoveTagArg	removeTagArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task	The task that represents the asynchronous send operation.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a RemoveTagError.

TagsRemoveAsync(String, String)

Remove a tag from an item.

Declaration

public Task TagsRemoveAsync(string path, string tagText)

Parameters

Type	Name	Description
System.String	path	Path to the item to tag.
System.String	tagText	The tag to remove.

Returns

Type	Description
System.Threading.Tasks.Task	The task that represents the asynchronous send operation.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a RemoveTagError.

UnlockFileBatchAsync(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.

Declaration

public Task<LockFileBatchResult> UnlockFileBatchAsync(UnlockFileBatchArg unlockFileBatchArg)

Parameters

Type	Name	Description
UnlockFileBatchArg	unlockFileBatchArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<LockFileBatchResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a LockFileError.

UnlockFileBatchAsync(IEnumerable<UnlockFileArg>)

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.

Declaration

public Task<LockFileBatchResult> UnlockFileBatchAsync(IEnumerable<UnlockFileArg> entries)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<UnlockFileArg>	entries	List of 'entries'. Each 'entry' contains a path of the file which will be unlocked. Duplicate path arguments in the batch are considered only once.

Returns

Type	Description
System.Threading.Tasks.Task<LockFileBatchResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a LockFileError.

UploadAsync(UploadArg, 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.

Declaration

public Task<FileMetadata> UploadAsync(UploadArg uploadArg, Stream body)

Parameters

Type	Name	Description
UploadArg	uploadArg	The request parameters
System.IO.Stream	body	The content to upload.

Returns

Type	Description
System.Threading.Tasks.Task<FileMetadata>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UploadError.

UploadAsync(String, WriteMode, Boolean, Nullable<DateTime>, Boolean, IEnumerable<PropertyGroup>, Boolean, String, 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.

Declaration

public Task<FileMetadata> UploadAsync(string path, WriteMode mode = null, bool autorename = false, DateTime? clientModified = null, bool mute = false, IEnumerable<PropertyGroup> propertyGroups = null, bool strictConflict = false, string contentHash = null, Stream body = null)

Parameters

Type	Name	Description
System.String	path	Path in the user's Dropbox to save the file.
WriteMode	mode	Selects what to do if the file already exists.
System.Boolean	autorename	If there's a conflict, as determined by mode, have the Dropbox server try to autorename the file to avoid conflict.
System.Nullable<System.DateTime>	clientModified	The value to store as the clientModified timestamp. Dropbox automatically records the time at which the file was written to the Dropbox servers. It can also record an additional timestamp, provided by Dropbox desktop clients, mobile clients, and API apps of when the file was actually created or modified.
System.Boolean	mute	Normally, users are made aware of any file modifications in their Dropbox account via notifications in the client software. If true, this tells the clients that this modification shouldn't result in a user notification.
System.Collections.Generic.IEnumerable<PropertyGroup>	propertyGroups	List of custom properties to add to file.
System.Boolean	strictConflict	Be more strict about how each WriteMode detects conflict. For example, always return a conflict error when mode = WriteMode.Update and the given "rev" doesn't match the existing file's "rev", even if the existing file has been deleted. This also forces a conflict even when the target path refers to a file with identical contents.
System.String	contentHash	A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash page.
System.IO.Stream	body	The document to upload

Returns

Type	Description
System.Threading.Tasks.Task<FileMetadata>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UploadError.

UploadSessionAppendAsync(UploadSessionCursor, Stream)

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.

Declaration

[Obsolete("This function is deprecated, please use UploadSessionAppendV2Async instead.")]
public Task UploadSessionAppendAsync(UploadSessionCursor uploadSessionCursor, Stream body)

Parameters

Type	Name	Description
UploadSessionCursor	uploadSessionCursor	The request parameters
System.IO.Stream	body	The content to upload.

Returns

Type	Description
System.Threading.Tasks.Task	The task that represents the asynchronous send operation.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UploadSessionAppendError.

UploadSessionAppendAsync(String, UInt64, Stream)

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.

Declaration

[Obsolete("This function is deprecated, please use UploadSessionAppendV2Async instead.")]
public Task UploadSessionAppendAsync(string sessionId, ulong offset, Stream body)

Parameters

Type	Name	Description
System.String	sessionId	The upload session ID (returned by UploadSessionStartAsync(UploadSessionStartArg, Stream)).
System.UInt64	offset	Offset in bytes at which data should be appended. We use this to make sure upload data isn't lost or duplicated in the event of a network error.
System.IO.Stream	body	The document to upload

Returns

Type	Description
System.Threading.Tasks.Task	The task that represents the asynchronous send operation.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UploadSessionAppendError.

UploadSessionAppendV2Async(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.

Declaration

public Task UploadSessionAppendV2Async(UploadSessionAppendArg uploadSessionAppendArg, Stream body)

Parameters

Type	Name	Description
UploadSessionAppendArg	uploadSessionAppendArg	The request parameters
System.IO.Stream	body	The content to upload.

Returns

Type	Description
System.Threading.Tasks.Task	The task that represents the asynchronous send operation.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UploadSessionAppendError.

UploadSessionAppendV2Async(UploadSessionCursor, Boolean, String, 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.

Declaration

public Task UploadSessionAppendV2Async(UploadSessionCursor cursor, bool close = false, string contentHash = null, Stream body = null)

Parameters

Type	Name	Description
UploadSessionCursor	cursor	Contains the upload session ID and the offset.
System.Boolean	close	If true, the current session will be closed, at which point you won't be able to call UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) anymore with the current session.
System.String	contentHash	A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash page.
System.IO.Stream	body	The document to upload

Returns

Type	Description
System.Threading.Tasks.Task	The task that represents the asynchronous send operation.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UploadSessionAppendError.

UploadSessionFinishAsync(UploadSessionCursor, CommitInfo, String, 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.

Declaration

public Task<FileMetadata> UploadSessionFinishAsync(UploadSessionCursor cursor, CommitInfo commit, string contentHash = null, Stream body = null)

Parameters

Type	Name	Description
UploadSessionCursor	cursor	Contains the upload session ID and the offset.
CommitInfo	commit	Contains the path and other optional modifiers for the commit.
System.String	contentHash	A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash page.
System.IO.Stream	body	The document to upload

Returns

Type	Description
System.Threading.Tasks.Task<FileMetadata>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UploadSessionFinishError.

UploadSessionFinishAsync(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.

Declaration

public Task<FileMetadata> UploadSessionFinishAsync(UploadSessionFinishArg uploadSessionFinishArg, Stream body)

Parameters

Type	Name	Description
UploadSessionFinishArg	uploadSessionFinishArg	The request parameters
System.IO.Stream	body	The content to upload.

Returns

Type	Description
System.Threading.Tasks.Task<FileMetadata>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UploadSessionFinishError.

UploadSessionFinishBatchAsync(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.

Declaration

[Obsolete("This function is deprecated, please use UploadSessionFinishBatchV2Async instead.")]
public Task<UploadSessionFinishBatchLaunch> UploadSessionFinishBatchAsync(UploadSessionFinishBatchArg uploadSessionFinishBatchArg)

Parameters

Type	Name	Description
UploadSessionFinishBatchArg	uploadSessionFinishBatchArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<UploadSessionFinishBatchLaunch>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

UploadSessionFinishBatchAsync(IEnumerable<UploadSessionFinishArg>)

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.

Declaration

[Obsolete("This function is deprecated, please use UploadSessionFinishBatchV2Async instead.")]
public Task<UploadSessionFinishBatchLaunch> UploadSessionFinishBatchAsync(IEnumerable<UploadSessionFinishArg> entries)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<UploadSessionFinishArg>	entries	Commit information for each file in the batch.

Returns

Type	Description
System.Threading.Tasks.Task<UploadSessionFinishBatchLaunch>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

UploadSessionFinishBatchCheckAsync(PollArg)

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

Declaration

public Task<UploadSessionFinishBatchJobStatus> UploadSessionFinishBatchCheckAsync(PollArg pollArg)

Parameters

Type	Name	Description
PollArg	pollArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<UploadSessionFinishBatchJobStatus>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

UploadSessionFinishBatchCheckAsync(String)

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

Declaration

public Task<UploadSessionFinishBatchJobStatus> UploadSessionFinishBatchCheckAsync(string asyncJobId)

Parameters

Type	Name	Description
System.String	asyncJobId	Id of the asynchronous job. This is the value of a response returned from the method that launched the job.

Returns

Type	Description
System.Threading.Tasks.Task<UploadSessionFinishBatchJobStatus>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a PollError.

UploadSessionFinishBatchV2Async(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 of each upload session. The maximum size of a file one can upload to an upload session is 350 GB.

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.

Declaration

public Task<UploadSessionFinishBatchResult> UploadSessionFinishBatchV2Async(UploadSessionFinishBatchArg uploadSessionFinishBatchArg)

Parameters

Type	Name	Description
UploadSessionFinishBatchArg	uploadSessionFinishBatchArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<UploadSessionFinishBatchResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

UploadSessionFinishBatchV2Async(IEnumerable<UploadSessionFinishArg>)

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 of each upload session. The maximum size of a file one can upload to an upload session is 350 GB.

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.

Declaration

public Task<UploadSessionFinishBatchResult> UploadSessionFinishBatchV2Async(IEnumerable<UploadSessionFinishArg> entries)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<UploadSessionFinishArg>	entries	Commit information for each file in the batch.

Returns

Type	Description
System.Threading.Tasks.Task<UploadSessionFinishBatchResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

UploadSessionStartAsync(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 7 days. Attempting to use an SessionId with UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) or UploadSessionFinishAsync(UploadSessionFinishArg, Stream) more than 7 days after its creation will return a UploadSessionLookupError.NotFound.

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.

By default, upload sessions require you to send content of the file in sequential order via consecutive UploadSessionStartAsync(UploadSessionStartArg, Stream), UploadSessionAppendV2Async(UploadSessionAppendArg, Stream), UploadSessionFinishAsync(UploadSessionFinishArg, Stream) calls. For better performance, you can instead optionally use a UploadSessionType.Concurrent upload session. To start a new concurrent session, set SessionType to UploadSessionType.Concurrent. After that, you can send file data in concurrent UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) requests. Finally finish the session with UploadSessionFinishAsync(UploadSessionFinishArg, Stream).

There are couple of constraints with concurrent sessions to make them work. You can not send data with UploadSessionStartAsync(UploadSessionStartArg, Stream) or UploadSessionFinishAsync(UploadSessionFinishArg, Stream) call, only with UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) call. Also data uploaded in UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) call must be multiple of 4194304 bytes (except for last UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) with Close to true, that may contain any remaining data).

Declaration

public Task<UploadSessionStartResult> UploadSessionStartAsync(UploadSessionStartArg uploadSessionStartArg, Stream body)

Parameters

Type	Name	Description
UploadSessionStartArg	uploadSessionStartArg	The request parameters
System.IO.Stream	body	The content to upload.

Returns

Type	Description
System.Threading.Tasks.Task<UploadSessionStartResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UploadSessionStartError.

UploadSessionStartAsync(Boolean, UploadSessionType, String, 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 7 days. Attempting to use an SessionId with UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) or UploadSessionFinishAsync(UploadSessionFinishArg, Stream) more than 7 days after its creation will return a UploadSessionLookupError.NotFound.

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.

By default, upload sessions require you to send content of the file in sequential order via consecutive UploadSessionStartAsync(UploadSessionStartArg, Stream), UploadSessionAppendV2Async(UploadSessionAppendArg, Stream), UploadSessionFinishAsync(UploadSessionFinishArg, Stream) calls. For better performance, you can instead optionally use a UploadSessionType.Concurrent upload session. To start a new concurrent session, set SessionType to UploadSessionType.Concurrent. After that, you can send file data in concurrent UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) requests. Finally finish the session with UploadSessionFinishAsync(UploadSessionFinishArg, Stream).

There are couple of constraints with concurrent sessions to make them work. You can not send data with UploadSessionStartAsync(UploadSessionStartArg, Stream) or UploadSessionFinishAsync(UploadSessionFinishArg, Stream) call, only with UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) call. Also data uploaded in UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) call must be multiple of 4194304 bytes (except for last UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) with Close to true, that may contain any remaining data).

Declaration

public Task<UploadSessionStartResult> UploadSessionStartAsync(bool close = false, UploadSessionType sessionType = null, string contentHash = null, Stream body = null)

Parameters

Type	Name	Description
System.Boolean	close	If true, the current session will be closed, at which point you won't be able to call UploadSessionAppendV2Async(UploadSessionAppendArg, Stream) anymore with the current session.
UploadSessionType	sessionType	Type of upload session you want to start. If not specified, default is UploadSessionType.Sequential.
System.String	contentHash	A hash of the file content uploaded in this call. If provided and the uploaded content does not match this hash, an error will be returned. For more information see our Content hash page.
System.IO.Stream	body	The document to upload

Returns

Type	Description
System.Threading.Tasks.Task<UploadSessionStartResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

Exceptions

Type	Condition
ApiException<TError>	Thrown if there is an error processing the request; This will contain a UploadSessionStartError.

UploadSessionStartBatchAsync(UploadSessionStartBatchArg)

This route starts batch of upload_sessions. Please refer to upload_session/start usage.

Declaration

public Task<UploadSessionStartBatchResult> UploadSessionStartBatchAsync(UploadSessionStartBatchArg uploadSessionStartBatchArg)

Parameters

Type	Name	Description
UploadSessionStartBatchArg	uploadSessionStartBatchArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<UploadSessionStartBatchResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.

UploadSessionStartBatchAsync(UInt64, UploadSessionType)

This route starts batch of upload_sessions. Please refer to upload_session/start usage.

Declaration

public Task<UploadSessionStartBatchResult> UploadSessionStartBatchAsync(ulong numSessions, UploadSessionType sessionType = null)

Parameters

Type	Name	Description
System.UInt64	numSessions	The number of upload sessions to start.
UploadSessionType	sessionType	Type of upload session you want to start. If not specified, default is UploadSessionType.Sequential.

Returns

Type	Description
System.Threading.Tasks.Task<UploadSessionStartBatchResult>	The task that represents the asynchronous send operation. The TResult parameter contains the response from the server.