com.box.androidsdk.content.requests

Class BoxRequestsFile.DownloadThumbnail

java.lang.Object

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

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

Enclosing class:

BoxRequestsFile

public static class BoxRequestsFile.DownloadThumbnail
extends BoxRequest<E,R>

Request for downloading a thumbnail

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	com.box.androidsdk.content.requests.BoxRequestDownload.DownloadRequestHandler A request handler that is designed to handle the parsing logic necessary for a BoxRequestDownload.

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
static int	SIZE_128
static int	SIZE_256
static int	SIZE_32
static int	SIZE_64

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

mBodyMap, mContentType, mHeaderMap, mListener, mQueryMap, mRequestMethod, mRequestUrlString, mSession

Constructor Summary

Constructors

Constructor and Description
BoxRequestsFile.DownloadThumbnail(java.io.File target, java.lang.String requestUrl, BoxSession session) Creates a download thumbnail to file request with the default parameters
BoxRequestsFile.DownloadThumbnail(java.io.OutputStream outputStream, java.lang.String requestUrl, BoxSession session) Creates a download thumbnail to output stream request with the default parameters

Method Summary

Methods

Modifier and Type	Method and Description
long	getRangeEnd() Returns the end range for the download.
long	getRangeStart() Returns the start range for the download.
java.io.File	getTarget() Returns the target file for the download.
java.io.OutputStream	getTargetStream() Returns the target output stream for the download.
java.lang.String	getVersion() If set in this request, the version id of an item to be downloaded.
protected void	logDebug(BoxHttpResponse response)
R	setDownloadStartListener(DownloadStartListener listener) Sets the download start listener for the request.
protected void	setHeaders(com.box.androidsdk.content.requests.BoxHttpRequest request)
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.
R	setProgressListener(ProgressListener listener) Sets the progress listener for the download request.
R	setRange(long rangeStart, long rangeEnd) The portion of a file to download.
R	setVersion(java.lang.String versionId) Sets the version of the file to download.

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

buildUrl, createHttpRequest, createQuery, getIfMatchEtag, getIfNoneMatchEtag, getRequestHandler, getSession, getStringBody, importRequestContentMapsFrom, logRequest, parseHashMapEntry, parseJsonObject, send, setBody, setContentType, setIfMatchEtag, setIfNoneMatchEtag, setRequestHandler, setTimeOut, toTask

Methods inherited from class java.lang.Object

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

Field Detail

SIZE_32

public static int SIZE_32

SIZE_64

public static int SIZE_64

SIZE_128

public static int SIZE_128

SIZE_256

public static int SIZE_256

Constructor Detail

BoxRequestsFile.DownloadThumbnail

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

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

Parameters:

outputStream - 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

BoxRequestsFile.DownloadThumbnail

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

Creates a download thumbnail to file request with the default parameters

Parameters:

target - 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

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.

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.

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.

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.

setHeaders

protected void setHeaders(com.box.androidsdk.content.requests.BoxHttpRequest request)

Overrides:

setHeaders in class BoxRequest<E extends BoxObject,R extends BoxRequest<E,R>>

logDebug

protected void logDebug(BoxHttpResponse response)
                 throws BoxException

Overrides:

logDebug in class BoxRequest<E extends BoxObject,R extends BoxRequest<E,R>>

Throws:

BoxException

getTarget

public java.io.File getTarget()

Returns the target file for the download.

Returns:

file to target for the download.

getTargetStream

public java.io.OutputStream getTargetStream()

Returns the target output stream for the download.

Returns:

output stream to target for the download.

getRangeStart

public long getRangeStart()

Returns the start range for the download.

Returns:

if set returns the start range specified by setRange, -1 otherwise.

getRangeEnd

public long getRangeEnd()

Returns the end range for the download.

Returns:

if set returns the end range specified by setRange, -1 otherwise.

setRange

public R setRange(long rangeStart,
         long rangeEnd)

The portion of a file to download.

Parameters:

rangeStart - value in bytes from which to begin downloading an item.

rangeEnd - value in bytes to end downloading an item.

Returns:

this download request

setVersion

public R setVersion(java.lang.String versionId)

Sets the version of the file to download.

Parameters:

versionId - the version id of an item if a previous version(see file_version field for file) is desired instead of the current.

Returns:

this download request

getVersion

public java.lang.String getVersion()

If set in this request, the version id of an item to be downloaded.

Returns:

the version set for this request.

setProgressListener

public R setProgressListener(ProgressListener listener)

Sets the progress listener for the download request.

Parameters:

listener - progress listener for the download.

Returns:

this download request.

setDownloadStartListener

public R setDownloadStartListener(DownloadStartListener listener)

Sets the download start listener for the request.

Parameters:

listener - an optional listener for knowing when the download for this request has started.

Returns:

this download request object.