com.dropbox.core.v2.files

Class ListFolderBuilder

java.lang.Object

com.dropbox.core.v2.files.ListFolderBuilder

public class ListFolderBuilder
extends java.lang.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(java.lang.Boolean includeDeleted) Set value for optional field.
ListFolderBuilder	withIncludeHasExplicitSharedMembers(java.lang.Boolean includeHasExplicitSharedMembers) Set value for optional field.
ListFolderBuilder	withIncludeMediaInfo(java.lang.Boolean includeMediaInfo) Set value for optional field.
ListFolderBuilder	withIncludeMountedFolders(java.lang.Boolean includeMountedFolders) Set value for optional field.
ListFolderBuilder	withIncludeNonDownloadableFiles(java.lang.Boolean includeNonDownloadableFiles) Set value for optional field.
ListFolderBuilder	withIncludePropertyGroups(TemplateFilterBase includePropertyGroups) Set value for optional field.
ListFolderBuilder	withLimit(java.lang.Long limit) Set value for optional field.
ListFolderBuilder	withRecursive(java.lang.Boolean recursive) Set value for optional field.
ListFolderBuilder	withSharedLink(SharedLink sharedLink) 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(java.lang.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(java.lang.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. This parameter will no longer have an effect starting December 2, 2019. Defaults to false when set to null.

Returns:

this builder

withIncludeDeleted

public ListFolderBuilder withIncludeDeleted(java.lang.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(java.lang.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

withIncludeMountedFolders

public ListFolderBuilder withIncludeMountedFolders(java.lang.Boolean includeMountedFolders)

Set value for optional field.

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

Parameters:

includeMountedFolders - If true, the results will include entries under mounted folders which includes app folder, shared folder and team folder. Defaults to true when set to null.

Returns:

this builder

withLimit

public ListFolderBuilder withLimit(java.lang.Long limit)

Set value for optional field.

Parameters:

limit - The maximum number of results to return per request. Note: This is an approximate number and there can be slightly more entries returned in some cases. Must be greater than or equal to 1 and be less than or equal to 2000.

Returns:

this builder

Throws:

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

withSharedLink

public ListFolderBuilder withSharedLink(SharedLink sharedLink)

Set value for optional field.

Parameters:

sharedLink - A shared link to list the contents of. If the link is password-protected, the password must be provided. If this field is present, ListFolderArg.getPath() will be relative to root of the shared link. Only non-recursive mode is supported for shared link.

Returns:

this builder

withIncludePropertyGroups

public ListFolderBuilder withIncludePropertyGroups(TemplateFilterBase includePropertyGroups)

Set value for optional field.

Parameters:

includePropertyGroups - If set to a valid list of template IDs, FileMetadata.getPropertyGroups() is set if there exists property data associated with the file and each of the listed templates.

Returns:

this builder

withIncludeNonDownloadableFiles

public ListFolderBuilder withIncludeNonDownloadableFiles(java.lang.Boolean includeNonDownloadableFiles)

Set value for optional field.

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

Parameters:

includeNonDownloadableFiles - If true, include files that are not downloadable, i.e. Google Docs. Defaults to true when set to null.

Returns:

this builder

start

public ListFolderResult start()
                       throws ListFolderErrorException,
                              DbxException

Issues the request.

Throws:

ListFolderErrorException

DbxException