Package com.dropbox.core.v2.clouddocs

Class RenameBuilder

java.lang.Object

com.dropbox.core.v2.clouddocs.RenameBuilder

public class RenameBuilder
extends java.lang.Object

The request builder returned by DbxUserCloudDocsRequests.renameBuilder().

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

Method Summary

Modifier and Type	Method	Description
RenameResult	start()	Issues the request.
RenameBuilder	withFileId(java.lang.String fileId)	Set value for optional field.
RenameBuilder	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

withFileId

public RenameBuilder withFileId(java.lang.String fileId)

Set value for optional field.

If left unset or set to null, defaults to "\"\"".

Parameters:

fileId - The API ID ("id:...") associated with the Cloud Doc. Must not be null. Defaults to "\"\"" when set to null.

Returns:

this builder

Throws:

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

withTitle

public RenameBuilder withTitle(java.lang.String title)

Set value for optional field.

If left unset or set to null, defaults to "\"\"".

Parameters:

title - The new title of the doc, excluding extension. Must not be null. Defaults to "\"\"" when set to null.

Returns:

this builder

Throws:

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

start

public RenameResult start()
                   throws RenameErrorException,
                          DbxException

Issues the request.

Throws:

RenameErrorException

DbxException