Class FileRequestsUserRoutes

The routes for the Dropbox.Api.FileRequests namespace

Inheritance

System.Object

FileRequestsUserRoutes

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.FileRequests.Routes

Assembly: Dropbox.Api.dll

Syntax

public class FileRequestsUserRoutes

Methods

BeginCount(AsyncCallback, Object)

Begins an asynchronous send to the count route.

Declaration

public IAsyncResult BeginCount(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.

BeginCreate(CreateFileRequestArgs, AsyncCallback, Object)

Begins an asynchronous send to the create route.

Declaration

public IAsyncResult BeginCreate(CreateFileRequestArgs createFileRequestArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
CreateFileRequestArgs	createFileRequestArgs	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.

BeginCreate(String, String, FileRequestDeadline, Boolean, String, AsyncCallback, Object)

Begins an asynchronous send to the create route.

Declaration

public IAsyncResult BeginCreate(string title, string destination, FileRequestDeadline deadline = null, bool open = true, string description = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	title	The title of the file request. Must not be empty.
System.String	destination	The path of the folder in the Dropbox where uploaded files will be sent. For apps with the app folder permission, this will be relative to the app folder.
FileRequestDeadline	deadline	The deadline for the file request. Deadlines can only be set by Professional and Business accounts.
System.Boolean	open	Whether or not the file request should be open. If the file request is closed, it will not accept any file submissions, but it can be opened later.
System.String	description	A description of the file request.
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(DeleteFileRequestArgs, AsyncCallback, Object)

Begins an asynchronous send to the delete route.

Declaration

public IAsyncResult BeginDelete(DeleteFileRequestArgs deleteFileRequestArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
DeleteFileRequestArgs	deleteFileRequestArgs	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(IEnumerable<String>, AsyncCallback, Object)

Begins an asynchronous send to the delete route.

Declaration

public IAsyncResult BeginDelete(IEnumerable<string> ids, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.String>	ids	List IDs of the file requests to delete.
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.

BeginDeleteAllClosed(AsyncCallback, Object)

Begins an asynchronous send to the delete all closed route.

Declaration

public IAsyncResult BeginDeleteAllClosed(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.

BeginGet(GetFileRequestArgs, AsyncCallback, Object)

Begins an asynchronous send to the get route.

Declaration

public IAsyncResult BeginGet(GetFileRequestArgs getFileRequestArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
GetFileRequestArgs	getFileRequestArgs	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.

BeginGet(String, AsyncCallback, Object)

Begins an asynchronous send to the get route.

Declaration

public IAsyncResult BeginGet(string id, AsyncCallback callback, object callbackState = null)

Parameters

Type	Name	Description
System.String	id	The ID of the file request to retrieve.
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.

BeginList(AsyncCallback, Object)

Begins an asynchronous send to the list route.

Declaration

public IAsyncResult BeginList(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.

BeginListContinue(ListFileRequestsContinueArg, AsyncCallback, Object)

Begins an asynchronous send to the list continue route.

Declaration

public IAsyncResult BeginListContinue(ListFileRequestsContinueArg listFileRequestsContinueArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListFileRequestsContinueArg	listFileRequestsContinueArg	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.

BeginListContinue(String, AsyncCallback, Object)

Begins an asynchronous send to the list continue route.

Declaration

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

Parameters

Type	Name	Description
System.String	cursor	The cursor returned by the previous API call specified in the endpoint description.
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.

BeginListV2(ListFileRequestsArg, AsyncCallback, Object)

Begins an asynchronous send to the list route.

Declaration

public IAsyncResult BeginListV2(ListFileRequestsArg listFileRequestsArg, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
ListFileRequestsArg	listFileRequestsArg	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.

BeginListV2(UInt64, AsyncCallback, Object)

Begins an asynchronous send to the list route.

Declaration

public IAsyncResult BeginListV2(ulong limit = 1000UL, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.UInt64	limit	The maximum number of file requests that should be returned per request.
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.

BeginUpdate(UpdateFileRequestArgs, AsyncCallback, Object)

Begins an asynchronous send to the update route.

Declaration

public IAsyncResult BeginUpdate(UpdateFileRequestArgs updateFileRequestArgs, AsyncCallback callback, object state = null)

Parameters

Type	Name	Description
UpdateFileRequestArgs	updateFileRequestArgs	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.

BeginUpdate(String, String, String, UpdateFileRequestDeadline, Nullable<Boolean>, String, AsyncCallback, Object)

Begins an asynchronous send to the update route.

Declaration

public IAsyncResult BeginUpdate(string id, string title = null, string destination = null, UpdateFileRequestDeadline deadline = null, bool? open = null, string description = null, AsyncCallback callback = null, object callbackState = null)

Parameters

Type	Name	Description
System.String	id	The ID of the file request to update.
System.String	title	The new title of the file request. Must not be empty.
System.String	destination	The new path of the folder in the Dropbox where uploaded files will be sent. For apps with the app folder permission, this will be relative to the app folder.
UpdateFileRequestDeadline	deadline	The new deadline for the file request. Deadlines can only be set by Professional and Business accounts.
System.Nullable<System.Boolean>	open	Whether to set this file request as open or closed.
System.String	description	The description of the file request.
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.

CountAsync()

Returns the total number of file requests owned by this user. Includes both open and closed file requests.

Declaration

public Task<CountFileRequestsResult> CountAsync()

Returns

Type	Description
System.Threading.Tasks.Task<CountFileRequestsResult>	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 CountFileRequestsError.

CreateAsync(CreateFileRequestArgs)

Creates a file request for this user.

Declaration

public Task<FileRequest> CreateAsync(CreateFileRequestArgs createFileRequestArgs)

Parameters

Type	Name	Description
CreateFileRequestArgs	createFileRequestArgs	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<FileRequest>	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 CreateFileRequestError.

CreateAsync(String, String, FileRequestDeadline, Boolean, String)

Creates a file request for this user.

Declaration

public Task<FileRequest> CreateAsync(string title, string destination, FileRequestDeadline deadline = null, bool open = true, string description = null)

Parameters

Type	Name	Description
System.String	title	The title of the file request. Must not be empty.
System.String	destination	The path of the folder in the Dropbox where uploaded files will be sent. For apps with the app folder permission, this will be relative to the app folder.
FileRequestDeadline	deadline	The deadline for the file request. Deadlines can only be set by Professional and Business accounts.
System.Boolean	open	Whether or not the file request should be open. If the file request is closed, it will not accept any file submissions, but it can be opened later.
System.String	description	A description of the file request.

Returns

Type	Description
System.Threading.Tasks.Task<FileRequest>	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 CreateFileRequestError.

DeleteAllClosedAsync()

Delete all closed file requests owned by this user.

Declaration

public Task<DeleteAllClosedFileRequestsResult> DeleteAllClosedAsync()

Returns

Type	Description
System.Threading.Tasks.Task<DeleteAllClosedFileRequestsResult>	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 DeleteAllClosedFileRequestsError.

DeleteAsync(DeleteFileRequestArgs)

Delete a batch of closed file requests.

Declaration

public Task<DeleteFileRequestsResult> DeleteAsync(DeleteFileRequestArgs deleteFileRequestArgs)

Parameters

Type	Name	Description
DeleteFileRequestArgs	deleteFileRequestArgs	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<DeleteFileRequestsResult>	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 DeleteFileRequestError.

DeleteAsync(IEnumerable<String>)

Delete a batch of closed file requests.

Declaration

public Task<DeleteFileRequestsResult> DeleteAsync(IEnumerable<string> ids)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.String>	ids	List IDs of the file requests to delete.

Returns

Type	Description
System.Threading.Tasks.Task<DeleteFileRequestsResult>	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 DeleteFileRequestError.

EndCount(IAsyncResult)

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

Declaration

public CountFileRequestsResult EndCount(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
CountFileRequestsResult	The response to the send request

Exceptions

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

EndCreate(IAsyncResult)

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

Declaration

public FileRequest EndCreate(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
FileRequest	The response to the send request

Exceptions

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

EndDelete(IAsyncResult)

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

Declaration

public DeleteFileRequestsResult EndDelete(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
DeleteFileRequestsResult	The response to the send request

Exceptions

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

EndDeleteAllClosed(IAsyncResult)

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

Declaration

public DeleteAllClosedFileRequestsResult EndDeleteAllClosed(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
DeleteAllClosedFileRequestsResult	The response to the send request

Exceptions

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

EndGet(IAsyncResult)

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

Declaration

public FileRequest EndGet(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
FileRequest	The response to the send request

Exceptions

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

EndList(IAsyncResult)

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

Declaration

public ListFileRequestsResult EndList(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
ListFileRequestsResult	The response to the send request

Exceptions

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

EndListContinue(IAsyncResult)

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

Declaration

public ListFileRequestsV2Result EndListContinue(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
ListFileRequestsV2Result	The response to the send request

Exceptions

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

EndListV2(IAsyncResult)

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

Declaration

public ListFileRequestsV2Result EndListV2(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
ListFileRequestsV2Result	The response to the send request

Exceptions

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

EndUpdate(IAsyncResult)

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

Declaration

public FileRequest EndUpdate(IAsyncResult asyncResult)

Parameters

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

Returns

Type	Description
FileRequest	The response to the send request

Exceptions

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

GetAsync(GetFileRequestArgs)

Returns the specified file request.

Declaration

public Task<FileRequest> GetAsync(GetFileRequestArgs getFileRequestArgs)

Parameters

Type	Name	Description
GetFileRequestArgs	getFileRequestArgs	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<FileRequest>	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 GetFileRequestError.

GetAsync(String)

Returns the specified file request.

Declaration

public Task<FileRequest> GetAsync(string id)

Parameters

Type	Name	Description
System.String	id	The ID of the file request to retrieve.

Returns

Type	Description
System.Threading.Tasks.Task<FileRequest>	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 GetFileRequestError.

ListAsync()

Returns a list of file requests owned by this user. For apps with the app folder permission, this will only return file requests with destinations in the app folder.

Declaration

public Task<ListFileRequestsResult> ListAsync()

Returns

Type	Description
System.Threading.Tasks.Task<ListFileRequestsResult>	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 ListFileRequestsError.

ListContinueAsync(ListFileRequestsContinueArg)

Once a cursor has been retrieved from ListV2Async(ListFileRequestsArg), use this to paginate through all file requests. The cursor must come from a previous call to ListV2Async(ListFileRequestsArg) or ListContinueAsync(ListFileRequestsContinueArg).

Declaration

public Task<ListFileRequestsV2Result> ListContinueAsync(ListFileRequestsContinueArg listFileRequestsContinueArg)

Parameters

Type	Name	Description
ListFileRequestsContinueArg	listFileRequestsContinueArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<ListFileRequestsV2Result>	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 ListFileRequestsContinueError.

ListContinueAsync(String)

Once a cursor has been retrieved from ListV2Async(ListFileRequestsArg), use this to paginate through all file requests. The cursor must come from a previous call to ListV2Async(ListFileRequestsArg) or ListContinueAsync(ListFileRequestsContinueArg).

Declaration

public Task<ListFileRequestsV2Result> ListContinueAsync(string cursor)

Parameters

Type	Name	Description
System.String	cursor	The cursor returned by the previous API call specified in the endpoint description.

Returns

Type	Description
System.Threading.Tasks.Task<ListFileRequestsV2Result>	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 ListFileRequestsContinueError.

ListV2Async(ListFileRequestsArg)

Returns a list of file requests owned by this user. For apps with the app folder permission, this will only return file requests with destinations in the app folder.

Declaration

public Task<ListFileRequestsV2Result> ListV2Async(ListFileRequestsArg listFileRequestsArg)

Parameters

Type	Name	Description
ListFileRequestsArg	listFileRequestsArg	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<ListFileRequestsV2Result>	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 ListFileRequestsError.

ListV2Async(UInt64)

Returns a list of file requests owned by this user. For apps with the app folder permission, this will only return file requests with destinations in the app folder.

Declaration

public Task<ListFileRequestsV2Result> ListV2Async(ulong limit = 1000UL)

Parameters

Type	Name	Description
System.UInt64	limit	The maximum number of file requests that should be returned per request.

Returns

Type	Description
System.Threading.Tasks.Task<ListFileRequestsV2Result>	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 ListFileRequestsError.

UpdateAsync(UpdateFileRequestArgs)

Update a file request.

Declaration

public Task<FileRequest> UpdateAsync(UpdateFileRequestArgs updateFileRequestArgs)

Parameters

Type	Name	Description
UpdateFileRequestArgs	updateFileRequestArgs	The request parameters

Returns

Type	Description
System.Threading.Tasks.Task<FileRequest>	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 UpdateFileRequestError.

UpdateAsync(String, String, String, UpdateFileRequestDeadline, Nullable<Boolean>, String)

Update a file request.

Declaration

public Task<FileRequest> UpdateAsync(string id, string title = null, string destination = null, UpdateFileRequestDeadline deadline = null, bool? open = null, string description = null)

Parameters

Type	Name	Description
System.String	id	The ID of the file request to update.
System.String	title	The new title of the file request. Must not be empty.
System.String	destination	The new path of the folder in the Dropbox where uploaded files will be sent. For apps with the app folder permission, this will be relative to the app folder.
UpdateFileRequestDeadline	deadline	The new deadline for the file request. Deadlines can only be set by Professional and Business accounts.
System.Nullable<System.Boolean>	open	Whether to set this file request as open or closed.
System.String	description	The description of the file request.

Returns

Type	Description
System.Threading.Tasks.Task<FileRequest>	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 UpdateFileRequestError.