Package com.dropbox.core.v2.files
Class DbxAppListFolderBuilder
- java.lang.Object
-
- com.dropbox.core.v2.files.DbxAppListFolderBuilder
-
public class DbxAppListFolderBuilder extends java.lang.Object
The request builder returned byDbxAppFilesRequests.listFolderBuilder(java.lang.String)
.Use this class to set optional request parameters and complete the request.
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListFolderResult
start()
Issues the request.DbxAppListFolderBuilder
withIncludeDeleted(java.lang.Boolean includeDeleted)
Set value for optional field.DbxAppListFolderBuilder
withIncludeHasExplicitSharedMembers(java.lang.Boolean includeHasExplicitSharedMembers)
Set value for optional field.DbxAppListFolderBuilder
withIncludeMediaInfo(java.lang.Boolean includeMediaInfo)
Set value for optional field.DbxAppListFolderBuilder
withIncludeMountedFolders(java.lang.Boolean includeMountedFolders)
Set value for optional field.DbxAppListFolderBuilder
withIncludeNonDownloadableFiles(java.lang.Boolean includeNonDownloadableFiles)
Set value for optional field.DbxAppListFolderBuilder
withIncludePropertyGroups(TemplateFilterBase includePropertyGroups)
Set value for optional field.DbxAppListFolderBuilder
withLimit(java.lang.Long limit)
Set value for optional field.DbxAppListFolderBuilder
withRecursive(java.lang.Boolean recursive)
Set value for optional field.DbxAppListFolderBuilder
withSharedLink(SharedLink sharedLink)
Set value for optional field.
-
-
-
Method Detail
-
withRecursive
public DbxAppListFolderBuilder withRecursive(java.lang.Boolean recursive)
Set value for optional field.If left unset or set to
null
, defaults tofalse
.- 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 tofalse
when set tonull
.- Returns:
- this builder
-
withIncludeMediaInfo
public DbxAppListFolderBuilder withIncludeMediaInfo(java.lang.Boolean includeMediaInfo)
Set value for optional field.If left unset or set to
null
, defaults tofalse
.- 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 tofalse
when set tonull
.- Returns:
- this builder
-
withIncludeDeleted
public DbxAppListFolderBuilder withIncludeDeleted(java.lang.Boolean includeDeleted)
Set value for optional field.If left unset or set to
null
, defaults tofalse
.- Parameters:
includeDeleted
- If true, the results will include entries for files and folders that used to exist but were deleted. Defaults tofalse
when set tonull
.- Returns:
- this builder
-
withIncludeHasExplicitSharedMembers
public DbxAppListFolderBuilder withIncludeHasExplicitSharedMembers(java.lang.Boolean includeHasExplicitSharedMembers)
Set value for optional field.If left unset or set to
null
, defaults tofalse
.- Parameters:
includeHasExplicitSharedMembers
- If true, the results will include a flag for each file indicating whether or not that file has any explicit members. Defaults tofalse
when set tonull
.- Returns:
- this builder
-
withIncludeMountedFolders
public DbxAppListFolderBuilder withIncludeMountedFolders(java.lang.Boolean includeMountedFolders)
Set value for optional field.If left unset or set to
null
, defaults totrue
.- Parameters:
includeMountedFolders
- If true, the results will include entries under mounted folders which includes app folder, shared folder and team folder. Defaults totrue
when set tonull
.- Returns:
- this builder
-
withLimit
public DbxAppListFolderBuilder 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 DbxAppListFolderBuilder 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 DbxAppListFolderBuilder 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 DbxAppListFolderBuilder withIncludeNonDownloadableFiles(java.lang.Boolean includeNonDownloadableFiles)
Set value for optional field.If left unset or set to
null
, defaults totrue
.- Parameters:
includeNonDownloadableFiles
- If true, include files that are not downloadable, i.e. Google Docs. Defaults totrue
when set tonull
.- Returns:
- this builder
-
start
public ListFolderResult start() throws ListFolderErrorException, DbxException
Issues the request.- Throws:
ListFolderErrorException
DbxException
-
-