com.dropbox.core.v2.filerequests

Class DbxUserFileRequestsRequests

java.lang.Object

com.dropbox.core.v2.filerequests.DbxUserFileRequestsRequests

public class DbxUserFileRequestsRequests
extends java.lang.Object

Routes in namespace "file_requests".

Constructor Summary

Constructors

Constructor and Description
DbxUserFileRequestsRequests(DbxRawClientV2 client)

Method Summary

Modifier and Type	Method and Description
FileRequest	create(java.lang.String title, java.lang.String destination) Creates a file request for this user.
CreateBuilder	createBuilder(java.lang.String title, java.lang.String destination) Creates a file request for this user.
FileRequest	get(java.lang.String id) Returns the specified file request.
ListFileRequestsResult	list() Returns a list of file requests owned by this user.
FileRequest	update(java.lang.String id) Update a file request.
UpdateBuilder	updateBuilder(java.lang.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 Detail

DbxUserFileRequestsRequests

public DbxUserFileRequestsRequests(DbxRawClientV2 client)

Method Detail

create

public FileRequest create(java.lang.String title,
                          java.lang.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:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

CreateFileRequestErrorException

DbxException

createBuilder

public CreateBuilder createBuilder(java.lang.String title,
                                   java.lang.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:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

get

public FileRequest get(java.lang.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:

java.lang.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

update

public FileRequest update(java.lang.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:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.

UpdateFileRequestErrorException

DbxException

updateBuilder

public UpdateBuilder updateBuilder(java.lang.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:

java.lang.IllegalArgumentException - If any argument does not meet its preconditions.