com.dropbox.core.v2.files

Class CopyBatchBuilder

java.lang.Object

com.dropbox.core.v2.files.CopyBatchBuilder

public class CopyBatchBuilder
extends Object

The request builder returned by DbxUserFilesRequests.copyBatchBuilder(java.util.List<com.dropbox.core.v2.files.RelocationPath>).

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

Method Summary

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

Set value for optional field.

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

Parameters:

allowSharedFolder - If true, DbxUserFilesRequests.copyBatch(java.util.List) will copy contents in shared folder, otherwise RelocationError.CANT_COPY_SHARED_FOLDER will be returned if RelocationPath.getFromPath() contains shared folder. This field is always true for DbxUserFilesRequests.moveBatch(java.util.List). Defaults to false when set to null.

Returns:

this builder

withAutorename

public CopyBatchBuilder 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 with any file, have the Dropbox server try to autorename that file to avoid the conflict. Defaults to false when set to null.

Returns:

this builder

start

public LaunchEmptyResult start()
                        throws DbxApiException,
                               DbxException

Issues the request.

Throws:

DbxApiException

DbxException