com.dropbox.core.v2.files

Class CopyBuilder

java.lang.Object

com.dropbox.core.v2.files.CopyBuilder

public class CopyBuilder
extends Object

The request builder returned by DbxUserFilesRequests.copyBuilder(java.lang.String, java.lang.String).

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

Method Summary

Modifier and Type	Method and Description
Metadata	start() Issues the request.
CopyBuilder	withAllowSharedFolder(Boolean allowSharedFolder) Set value for optional field.
CopyBuilder	withAutorename(Boolean autorename) 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

withAllowSharedFolder

public CopyBuilder withAllowSharedFolder(Boolean allowSharedFolder)

Set value for optional field.

If left unset or set to null, defaults to false.

Parameters:

allowSharedFolder - If true, DbxUserFilesRequests.copy(String,String) will copy contents in shared folder, otherwise RelocationError.CANT_COPY_SHARED_FOLDER will be returned if RelocationArg.getFromPath() contains shared folder. This field is always true for DbxUserFilesRequests.move(String,String). Defaults to false when set to null.

Returns:

this builder

withAutorename

public CopyBuilder withAutorename(Boolean autorename)

Set value for optional field.

If left unset or set to null, defaults to false.

Parameters:

autorename - If there's a conflict, have the Dropbox server try to autorename the file to avoid the conflict. Defaults to false when set to null.

Returns:

this builder

start

public Metadata start()
               throws RelocationErrorException,
                      DbxException

Issues the request.

Throws:

RelocationErrorException

DbxException