com.box.androidsdk.content.requests

Class BoxRequestsFile.DownloadThumbnail

java.lang.Object

com.box.androidsdk.content.requests.BoxRequest<E,R>

com.box.androidsdk.content.requests.BoxRequestDownload<BoxDownload,BoxRequestsFile.DownloadThumbnail>

com.box.androidsdk.content.requests.BoxRequestsFile.DownloadThumbnail

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsFile

public static class BoxRequestsFile.DownloadThumbnail
extends BoxRequestDownload<BoxDownload,BoxRequestsFile.DownloadThumbnail>

Request for downloading a thumbnail

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoxRequestsFile.DownloadThumbnail.Format

Nested classes/interfaces inherited from class com.box.androidsdk.content.requests.BoxRequestDownload

BoxRequestDownload.DownloadRequestHandler

Nested classes/interfaces inherited from class com.box.androidsdk.content.requests.BoxRequest

BoxRequest.BoxRequestHandler<R extends BoxRequest>, BoxRequest.ContentTypes, BoxRequest.Methods

Field Summary

Fields

Modifier and Type	Field and Description
protected BoxRequestsFile.DownloadThumbnail.Format	mFormat
static int	SIZE_128
static int	SIZE_160
static int	SIZE_256
static int	SIZE_32
static int	SIZE_320
static int	SIZE_64
static int	SIZE_94

Fields inherited from class com.box.androidsdk.content.requests.BoxRequestDownload

mDownloadStartListener, mFileOutputStream, mId, mRangeEnd, mRangeStart, mTarget

Fields inherited from class com.box.androidsdk.content.requests.BoxRequest

JSON_OBJECT, mBodyMap, mContentType, mHeaderMap, mListener, mQueryMap, mRequestMethod, mRequestUrlString, mRequiresSocket, mSession, mTimeout

Constructor Summary

Constructors

Constructor and Description
DownloadThumbnail(java.io.File target, java.lang.String requestUrl, BoxSession session) Deprecated. Please use the DownloadFile constructor that takes in an id as this method may be removed in future releases
DownloadThumbnail(java.io.OutputStream outputStream, java.lang.String requestUrl, BoxSession session) Deprecated. Please use the DownloadFile constructor that takes in an id as this method may be removed in future releases
DownloadThumbnail(java.lang.String id, java.io.File target, java.lang.String requestUrl, BoxSession session) Creates a download thumbnail to file request with the default parameters
DownloadThumbnail(java.lang.String id, java.io.OutputStream outputStream, java.lang.String requestUrl, BoxSession session) Creates a download thumbnail to output stream request with the default parameters

Method Summary

Modifier and Type	Method and Description
protected java.net.URL	buildUrl()
BoxRequestsFile.DownloadThumbnail.Format	getFormat() Gets the file format of the thumbnail that will be downloaded
java.lang.Integer	getMaxHeight() Gets the maximum height for the thumbnail in the request
java.lang.Integer	getMaxWidth() Gets the maximum width for the thumbnail in the request
java.lang.Integer	getMinHeight() Gets the minimum height for the thumbnail in the request
java.lang.Integer	getMinWidth() Gets the minimum width for the thumbnail in the request
protected java.lang.String	getThumbnailExtension() Gets the recommended thumbnail extension for the set thumbnail size.
BoxRequestsFile.DownloadThumbnail	setFormat(BoxRequestsFile.DownloadThumbnail.Format format) Sets the file format of the thumbnail that will be downloaded.
BoxRequestsFile.DownloadThumbnail	setMaxHeight(int height) Sets the maximum height for the thumbnail in the request.
BoxRequestsFile.DownloadThumbnail	setMaxWidth(int width) Sets the maximum width for the thumbnail in the request.
BoxRequestsFile.DownloadThumbnail	setMinHeight(int height) Sets the minimum height for the thumbnail in the request.
BoxRequestsFile.DownloadThumbnail	setMinSize(int size) Sets both the minimum height and minimum width for the thumbnail in the request.
BoxRequestsFile.DownloadThumbnail	setMinWidth(int width) Sets the minimum width for the thumbnail in the request.

Methods inherited from class com.box.androidsdk.content.requests.BoxRequestDownload

getId, getRangeEnd, getRangeStart, getTarget, getTargetStream, getVersion, logDebug, setDownloadStartListener, setHeaders, setProgressListener, setRange, setVersion

Methods inherited from class com.box.androidsdk.content.requests.BoxRequest

createHeaderMap, createHttpRequest, createQuery, equals, getIfMatchEtag, getIfNoneMatchEtag, getRequestHandler, getSession, getSocket, getStringBody, handleSendForCachedResult, handleToTaskForCachedResult, handleUpdateCache, hashCode, importRequestContentMapsFrom, logRequest, onSend, onSendCompleted, parseHashMapEntry, parseJsonObject, send, sendRequest, setBody, setContentType, setIfMatchEtag, setIfNoneMatchEtag, setRequestHandler, setTimeOut, toTask

Methods inherited from class java.lang.Object

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

Field Detail

SIZE_32

public static int SIZE_32

SIZE_64

public static int SIZE_64

SIZE_94

public static int SIZE_94

SIZE_128

public static int SIZE_128

SIZE_160

public static int SIZE_160

SIZE_256

public static int SIZE_256

SIZE_320

public static int SIZE_320

mFormat

protected BoxRequestsFile.DownloadThumbnail.Format mFormat

Constructor Detail

DownloadThumbnail

public DownloadThumbnail(java.lang.String id,
                         java.io.OutputStream outputStream,
                         java.lang.String requestUrl,
                         BoxSession session)

Creates a download thumbnail to output stream request with the default parameters

Parameters:

id - The id of the file to download the thumbnail for

outputStream - The output stream to download the thumbnail to

requestUrl - URL of the download thumbnail endpoint

session - The authenticated session that will be used to make the request with

DownloadThumbnail

@Deprecated
public DownloadThumbnail(java.io.OutputStream outputStream,
                                     java.lang.String requestUrl,
                                     BoxSession session)

Deprecated. Please use the DownloadFile constructor that takes in an id as this method may be removed in future releases

Creates a download thumbnail to output stream request with the default parameters

Parameters:

outputStream - The output stream to download the thumbnail to

requestUrl - URL of the download thumbnail endpoint

session - The authenticated session that will be used to make the request with

DownloadThumbnail

public DownloadThumbnail(java.lang.String id,
                         java.io.File target,
                         java.lang.String requestUrl,
                         BoxSession session)

Creates a download thumbnail to file request with the default parameters

Parameters:

id - The id of the file to download a thumbnail for

target - The target file to download thumbnail to

requestUrl - URL of the download thumbnail endpoint

session - The authenticated session that will be used to make the request with

DownloadThumbnail

@Deprecated
public DownloadThumbnail(java.io.File target,
                                     java.lang.String requestUrl,
                                     BoxSession session)

Deprecated. Please use the DownloadFile constructor that takes in an id as this method may be removed in future releases

Creates a download thumbnail to file request with the default parameters

Parameters:

target - The target file to download thumbnail to

requestUrl - URL of the download thumbnail endpoint

session - The authenticated session that will be used to make the request with

Method Detail

getMinWidth

public java.lang.Integer getMinWidth()

Gets the minimum width for the thumbnail in the request

Returns:

the minimum width of the thumbnail

setMinWidth

public BoxRequestsFile.DownloadThumbnail setMinWidth(int width)

Sets the minimum width for the thumbnail in the request.

Parameters:

width - int for the minimum width.

Returns:

request with the updated minimum width.

getMaxWidth

public java.lang.Integer getMaxWidth()

Gets the maximum width for the thumbnail in the request

Returns:

the maximum width of the thumbnail

setMaxWidth

public BoxRequestsFile.DownloadThumbnail setMaxWidth(int width)

Sets the maximum width for the thumbnail in the request.

Parameters:

width - int for the maximum width.

Returns:

request with the updated maximum width.

getMinHeight

public java.lang.Integer getMinHeight()

Gets the minimum height for the thumbnail in the request

Returns:

the minimum height of the thumbnail

setMinHeight

public BoxRequestsFile.DownloadThumbnail setMinHeight(int height)

Sets the minimum height for the thumbnail in the request.

Parameters:

height - int for the minimum height.

Returns:

request with the updated minimum height.

getMaxHeight

public java.lang.Integer getMaxHeight()

Gets the maximum height for the thumbnail in the request

Returns:

the maximum height of the thumbnail

setMaxHeight

public BoxRequestsFile.DownloadThumbnail setMaxHeight(int height)

Sets the maximum height for the thumbnail in the request.

Parameters:

height - int for the maximum height.

Returns:

request with the updated maximum height.

setMinSize

public BoxRequestsFile.DownloadThumbnail setMinSize(int size)

Sets both the minimum height and minimum width for the thumbnail in the request.

Parameters:

size - int for the minimum height and minimum width.

Returns:

request with the updated minimum size.

setFormat

public BoxRequestsFile.DownloadThumbnail setFormat(BoxRequestsFile.DownloadThumbnail.Format format)

Sets the file format of the thumbnail that will be downloaded. This overrides the default behavior of returning the best file format for the requested thumbnail size.

Parameters:

format - Format of the thumbnail to return

Returns:

The updated DownloadThumbnail request

getFormat

public BoxRequestsFile.DownloadThumbnail.Format getFormat()

Gets the file format of the thumbnail that will be downloaded

Returns:

The file format of the thumbnail

buildUrl

protected java.net.URL buildUrl()
                         throws java.net.MalformedURLException,
                                java.io.UnsupportedEncodingException

Overrides:

buildUrl in class BoxRequest<BoxDownload,BoxRequestsFile.DownloadThumbnail>

Throws:

java.net.MalformedURLException

java.io.UnsupportedEncodingException

getThumbnailExtension

protected java.lang.String getThumbnailExtension()

Gets the recommended thumbnail extension for the set thumbnail size. Defaults to JPG if no sizing values have been set

Returns:

default thumbnail extension