com.dropbox.core.v2.files

Class GetMetadataBuilder

java.lang.Object

com.dropbox.core.v2.files.GetMetadataBuilder

public class GetMetadataBuilder
extends java.lang.Object

The request builder returned by DbxUserFilesRequests.getMetadataBuilder(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.
GetMetadataBuilder	withIncludeDeleted(java.lang.Boolean includeDeleted) Set value for optional field.
GetMetadataBuilder	withIncludeHasExplicitSharedMembers(java.lang.Boolean includeHasExplicitSharedMembers) Set value for optional field.
GetMetadataBuilder	withIncludeMediaInfo(java.lang.Boolean includeMediaInfo) Set value for optional field.
GetMetadataBuilder	withIncludePropertyGroups(TemplateFilterBase includePropertyGroups) 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

withIncludeMediaInfo

public GetMetadataBuilder 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. Defaults to false when set to null.

Returns:

this builder

withIncludeDeleted

public GetMetadataBuilder withIncludeDeleted(java.lang.Boolean includeDeleted)

Set value for optional field.

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

Parameters:

includeDeleted - If true, DeletedMetadata will be returned for deleted file or folder, otherwise LookupError.NOT_FOUND will be returned. Defaults to false when set to null.

Returns:

this builder

withIncludeHasExplicitSharedMembers

public GetMetadataBuilder 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

withIncludePropertyGroups

public GetMetadataBuilder 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

start

public Metadata start()
               throws GetMetadataErrorException,
                      DbxException

Issues the request.

Throws:

GetMetadataErrorException

DbxException