Package com.dropbox.core.v2.files

Class DbxUserGetThumbnailV2Builder

java.lang.Object

com.dropbox.core.v2.DbxDownloadStyleBuilder<PreviewResult>

com.dropbox.core.v2.files.DbxUserGetThumbnailV2Builder

public class DbxUserGetThumbnailV2Builder
extends DbxDownloadStyleBuilder<PreviewResult>

The request builder returned by DbxUserFilesRequests.getThumbnailV2Builder(com.dropbox.core.v2.files.PathOrLink).

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

Method Summary

Modifier and Type	Method	Description
DbxDownloader<PreviewResult>	start()	Issues the download request using this builder's request parameters and returns a DbxDownloader for reading the response body.
DbxUserGetThumbnailV2Builder	withExcludeMediaInfo(Boolean excludeMediaInfo)	Set value for optional field.
DbxUserGetThumbnailV2Builder	withFormat(ThumbnailFormat format)	Set value for optional field.
DbxUserGetThumbnailV2Builder	withMode(ThumbnailMode mode)	Set value for optional field.
DbxUserGetThumbnailV2Builder	withQuality(ThumbnailQuality quality)	Set value for optional field.
DbxUserGetThumbnailV2Builder	withSize(ThumbnailSize size)	Set value for optional field.

Methods inherited from class com.dropbox.core.v2.DbxDownloadStyleBuilder

download, getHeaders, range, range

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

withFormat

public DbxUserGetThumbnailV2Builder withFormat(ThumbnailFormat format)

Set value for optional field.

If left unset or set to null, defaults to ThumbnailFormat.JPEG.

Parameters:

format - The format for the thumbnail image, jpeg (default), png, or webp. For images that are photos, jpeg should be preferred, while png is better for screenshots and digital arts, and web for compression. Must not be null. Defaults to ThumbnailFormat.JPEG when set to null.

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withSize

public DbxUserGetThumbnailV2Builder withSize(ThumbnailSize size)

Set value for optional field.

If left unset or set to null, defaults to ThumbnailSize.W64H64.

Parameters:

size - The size for the thumbnail image. Must not be null. Defaults to ThumbnailSize.W64H64 when set to null.

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withMode

public DbxUserGetThumbnailV2Builder withMode(ThumbnailMode mode)

Set value for optional field.

If left unset or set to null, defaults to ThumbnailMode.STRICT.

Parameters:

mode - How to resize and crop the image to achieve the desired size. Must not be null. Defaults to ThumbnailMode.STRICT when set to null.

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withQuality

public DbxUserGetThumbnailV2Builder withQuality(ThumbnailQuality quality)

Set value for optional field.

If left unset or set to null, defaults to ThumbnailQuality.QUALITY_80.

Parameters:

quality - Quality of the thumbnail image. Must not be null. Defaults to ThumbnailQuality.QUALITY_80 when set to null.

Returns:

this builder

Throws:

IllegalArgumentException - If any argument does not meet its preconditions.

withExcludeMediaInfo

public DbxUserGetThumbnailV2Builder withExcludeMediaInfo(Boolean excludeMediaInfo)

Set value for optional field.

Parameters:

excludeMediaInfo - Normally, FileMetadata.getMediaInfo() is set for photo and video. When this flag is true, FileMetadata.getMediaInfo() is not populated. This improves latency for use cases where `media_info` is not needed.

Returns:

this builder

start

public DbxDownloader<PreviewResult> start()
                                   throws ThumbnailV2ErrorException,
DbxException

Description copied from class: DbxDownloadStyleBuilder

Issues the download request using this builder's request parameters and returns a DbxDownloader for reading the response body. Callers should fully read the response body using DbxDownloader.getInputStream() and close the downloader afterwards (see DbxDownloader.close()). This will allow for proper resource deallocation and connection re-use.. See DbxDownloadStyleBuilder.download(java.io.OutputStream) convenience method for a simpler way to complete the request.

Specified by:

start in class DbxDownloadStyleBuilder<PreviewResult>

Returns:

DbxDownloader used to download data and read the response.

Throws:

DbxException - if an error occursing issuing the request

ThumbnailV2ErrorException