Package com.dropbox.core.v2.filerequests

Class DbxUserFileRequestsRequests

java.lang.Object

com.dropbox.core.v2.filerequests.DbxUserFileRequestsRequests

public class DbxUserFileRequestsRequests
extends Object

Routes in namespace "file_requests".

Constructor Summary

Constructors

Constructor	Description
DbxUserFileRequestsRequests(DbxRawClientV2 client)

Method Summary

Modifier and Type	Method	Description
CountFileRequestsResult	count()	Returns the total number of file requests owned by this user.
FileRequest	create(String title, String destination)	Creates a file request for this user.
CreateBuilder	createBuilder(String title, String destination)	Creates a file request for this user.
DeleteFileRequestsResult	delete(List<String> ids)	Delete a batch of closed file requests.
DeleteAllClosedFileRequestsResult	deleteAllClosed()	Delete all closed file requests owned by this user.
FileRequest	get(String id)	Returns the specified file request.
ListFileRequestsResult	list()	Returns a list of file requests owned by this user.
ListFileRequestsV2Result	listContinue(String cursor)	Once a cursor has been retrieved from listV2(long), use this to paginate through all file requests.
ListFileRequestsV2Result	listV2()	Returns a list of file requests owned by this user.
ListFileRequestsV2Result	listV2(long limit)	Returns a list of file requests owned by this user.
FileRequest	update(String id)	Update a file request.
UpdateBuilder	updateBuilder(String id)	Update a file request.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DbxUserFileRequestsRequests

public DbxUserFileRequestsRequests(DbxRawClientV2 client)

Method Details

count

public CountFileRequestsResult count()
                              throws CountFileRequestsErrorException,
DbxException

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

Returns:

Result for count().

Throws:

CountFileRequestsErrorException

DbxException

create

public FileRequest create(String title,
 String destination)
                   throws CreateFileRequestErrorException,
DbxException

Creates a file request for this user.

The default values for the optional request parameters will be used. See CreateBuilder for more details.

Parameters:

title - The title of the file request. Must not be empty. Must have length of at least 1 and not be null.

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. Must match pattern " /(.|[\\r\\n])*" and not be null.

Returns:

A file request for receiving files into the user's Dropbox account.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

CreateFileRequestErrorException

DbxException

createBuilder

public CreateBuilder createBuilder(String title,
 String destination)

Creates a file request for this user.

Parameters:

title - The title of the file request. Must not be empty. Must have length of at least 1 and not be null.

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. Must match pattern " /(.|[\\r\\n])*" and not be null.

Returns:

Request builder for configuring request parameters and completing the request.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

delete

public DeleteFileRequestsResult delete(List<String> ids)
                                throws DeleteFileRequestErrorException,
DbxException

Delete a batch of closed file requests.

Parameters:

ids - List IDs of the file requests to delete. Must not contain a null item and not be null.

Returns:

Result for delete(List).

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

DeleteFileRequestErrorException

DbxException

deleteAllClosed

public DeleteAllClosedFileRequestsResult deleteAllClosed()
                                                  throws DeleteAllClosedFileRequestsErrorException,
DbxException

Delete all closed file requests owned by this user.

Returns:

Result for deleteAllClosed().

Throws:

DeleteAllClosedFileRequestsErrorException

DbxException

get

public FileRequest get(String id)
                throws GetFileRequestErrorException,
DbxException

Returns the specified file request.

Parameters:

id - The ID of the file request to retrieve. Must have length of at least 1, match pattern "[-_0-9a-zA-Z]+", and not be null.

Returns:

A file request for receiving files into the user's Dropbox account.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

GetFileRequestErrorException

DbxException

list

public ListFileRequestsResult list()
                            throws ListFileRequestsErrorException,
DbxException

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.

Returns:

Result for list().

Throws:

ListFileRequestsErrorException

DbxException

listV2

public ListFileRequestsV2Result listV2()
                                throws ListFileRequestsErrorException,
DbxException

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.

The limit request parameter will default to 1000L (see listV2(long)).

Returns:

Result for listV2(long) and listContinue(String).

Throws:

ListFileRequestsErrorException

DbxException

listV2

public ListFileRequestsV2Result listV2(long limit)
                                throws ListFileRequestsErrorException,
DbxException

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.

Parameters:

limit - The maximum number of file requests that should be returned per request.

Returns:

Result for listV2(long) and listContinue(String).

Throws:

ListFileRequestsErrorException

DbxException

listContinue

public ListFileRequestsV2Result listContinue(String cursor)
                                      throws ListFileRequestsContinueErrorException,
DbxException

Once a cursor has been retrieved from listV2(long), use this to paginate through all file requests. The cursor must come from a previous call to listV2(long) or listContinue(String).

Parameters:

cursor - The cursor returned by the previous API call specified in the endpoint description. Must not be null.

Returns:

Result for listV2(long) and listContinue(String).

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

ListFileRequestsContinueErrorException

DbxException

update

public FileRequest update(String id)
                   throws UpdateFileRequestErrorException,
DbxException

Update a file request.

The default values for the optional request parameters will be used. See UpdateBuilder for more details.

Parameters:

id - The ID of the file request to update. Must have length of at least 1, match pattern "[-_0-9a-zA-Z]+", and not be null.

Returns:

A file request for receiving files into the user's Dropbox account.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

UpdateFileRequestErrorException

DbxException

updateBuilder

public UpdateBuilder updateBuilder(String id)

Update a file request.

Parameters:

id - The ID of the file request to update. Must have length of at least 1, match pattern "[-_0-9a-zA-Z]+", and not be null.

Returns:

Request builder for configuring request parameters and completing the request.

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.