Package com.dropbox.core.v2.filerequests

Class UpdateBuilder

java.lang.Object

com.dropbox.core.v2.filerequests.UpdateBuilder

public class UpdateBuilder
extends java.lang.Object

The request builder returned by DbxUserFileRequestsRequests.updateBuilder(java.lang.String).

Use this class to set optional request parameters and complete the request.

Method Summary

Modifier and Type	Method	Description
FileRequest	start()	Issues the request.
UpdateBuilder	withDeadline(UpdateFileRequestDeadline deadline)	Set value for optional field.
UpdateBuilder	withDescription(java.lang.String description)	Set value for optional field.
UpdateBuilder	withDestination(java.lang.String destination)	Set value for optional field.
UpdateBuilder	withOpen(java.lang.Boolean open)	Set value for optional field.
UpdateBuilder	withTitle(java.lang.String title)	Set value for optional field.

Methods inherited from class java.lang.Object

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

Method Detail

withTitle

public UpdateBuilder withTitle(java.lang.String title)

Set value for optional field.

Parameters:

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

Returns:

this builder

Throws:

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

withDestination

public UpdateBuilder withDestination(java.lang.String destination)

Set value for optional field.

Parameters:

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

Returns:

this builder

Throws:

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

withDeadline

public UpdateBuilder withDeadline(UpdateFileRequestDeadline deadline)

Set value for optional field.

If left unset or set to null, defaults to UpdateFileRequestDeadline.NO_UPDATE.

Parameters:

deadline - The new deadline for the file request. Deadlines can only be set by Professional and Business accounts. Must not be null. Defaults to UpdateFileRequestDeadline.NO_UPDATE when set to null.

Returns:

this builder

Throws:

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

withOpen

public UpdateBuilder withOpen(java.lang.Boolean open)

Set value for optional field.

Parameters:

open - Whether to set this file request as open or closed.

Returns:

this builder

withDescription

public UpdateBuilder withDescription(java.lang.String description)

Set value for optional field.

Parameters:

description - The description of the file request.

Returns:

this builder

start

public FileRequest start()
                  throws UpdateFileRequestErrorException,
                         DbxException

Issues the request.

Throws:

UpdateFileRequestErrorException

DbxException