com.dropbox.core.v2.files

Class ListFolderBuilder

java.lang.Object

com.dropbox.core.v2.files.ListFolderBuilder

public class ListFolderBuilder
extends Object

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

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

Method Summary

Modifier and Type	Method and Description
ListFolderResult	start() Issues the request.
ListFolderBuilder	withIncludeDeleted(Boolean includeDeleted) Set value for optional field.
ListFolderBuilder	withIncludeHasExplicitSharedMembers(Boolean includeHasExplicitSharedMembers) Set value for optional field.
ListFolderBuilder	withIncludeMediaInfo(Boolean includeMediaInfo) Set value for optional field.
ListFolderBuilder	withRecursive(Boolean recursive) 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

withRecursive

public ListFolderBuilder withRecursive(Boolean recursive)

Set value for optional field.

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

Parameters:

recursive - If true, the list folder operation will be applied recursively to all subfolders and the response will contain contents of all subfolders. Defaults to false when set to null.

Returns:

this builder

withIncludeMediaInfo

public ListFolderBuilder withIncludeMediaInfo(Boolean includeMediaInfo)

Set value for optional field.

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

Parameters:

includeMediaInfo - If true, FileMetadata.getMediaInfo() is set for photo and video. Defaults to false when set to null.

Returns:

this builder

withIncludeDeleted

public ListFolderBuilder withIncludeDeleted(Boolean includeDeleted)

Set value for optional field.

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

Parameters:

includeDeleted - If true, the results will include entries for files and folders that used to exist but were deleted. Defaults to false when set to null.

Returns:

this builder

withIncludeHasExplicitSharedMembers

public ListFolderBuilder withIncludeHasExplicitSharedMembers(Boolean includeHasExplicitSharedMembers)

Set value for optional field.

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

Parameters:

includeHasExplicitSharedMembers - If true, the results will include a flag for each file indicating whether or not that file has any explicit members. Defaults to false when set to null.

Returns:

this builder

start

public ListFolderResult start()
                       throws ListFolderErrorException,
                              DbxException

Issues the request.

Throws:

ListFolderErrorException

DbxException