com.box.androidsdk.preview.ext

Class BoxRequestsPreview.DownloadPreview

java.lang.Object

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

com.box.androidsdk.content.requests.BoxRequestDownload<com.box.androidsdk.content.models.BoxDownload,BoxRequestsPreview.DownloadPreview>

com.box.androidsdk.preview.ext.BoxRequestsPreview.DownloadPreview

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsPreview

public static class BoxRequestsPreview.DownloadPreview
extends com.box.androidsdk.content.requests.BoxRequestDownload<com.box.androidsdk.content.models.BoxDownload,BoxRequestsPreview.DownloadPreview>

Request to download a preview

See Also:

Serialized Form

Nested Class Summary

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

com.box.androidsdk.content.requests.BoxRequestDownload.DownloadRequestHandler

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

com.box.androidsdk.content.requests.BoxRequest.BoxRequestHandler<R extends com.box.androidsdk.content.requests.BoxRequest>, com.box.androidsdk.content.requests.BoxRequest.ContentTypes, com.box.androidsdk.content.requests.BoxRequest.Methods

Field Summary

Fields

Modifier and Type	Field and Description
static int	SIZE_1024
static int	SIZE_1600
static int	SIZE_2048

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
DownloadPreview(java.lang.String id, java.io.OutputStream outputStream, java.lang.String requestUrl, com.box.androidsdk.content.models.BoxSession session) Constructs a new request to download a preview

Method Summary

Modifier and Type	Method and Description
java.lang.Integer	getMaxHeight() Gets the maximum height for the preview request.
java.lang.Integer	getMaxWidth() Gets the maximum width for the preview request.
java.lang.Integer	getMinHeight() Gets the minimum height for the preview request.
java.lang.Integer	getMinWidth() Gets the minimum width for the preview request.
java.lang.Integer	getPage()
BoxRequestsPreview.DownloadPreview	setMaxHeight(int height) Sets the maximum height for the preview request.
BoxRequestsPreview.DownloadPreview	setMaxSize(int size) Sets both the maximum height and maximum width for the preview request.
BoxRequestsPreview.DownloadPreview	setMaxWidth(int width) Sets the maximum width for the preview request.
BoxRequestsPreview.DownloadPreview	setMinHeight(int height) Sets the minimum height for the preview request.
BoxRequestsPreview.DownloadPreview	setMinSize(int size) Sets both the minimum height and minimum width for the preview request.
BoxRequestsPreview.DownloadPreview	setMinWidth(int width) Sets the minimum width for the preview request.
BoxRequestsPreview.DownloadPreview	setPage(int pageNumber)

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

buildUrl, 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_1024

public static int SIZE_1024

SIZE_1600

public static int SIZE_1600

SIZE_2048

public static int SIZE_2048

Constructor Detail

DownloadPreview

public DownloadPreview(java.lang.String id,
                       java.io.OutputStream outputStream,
                       java.lang.String requestUrl,
                       com.box.androidsdk.content.models.BoxSession session)

Constructs a new request to download a preview

Parameters:

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

outputStream - The output stream to download the preview to

requestUrl - URL for the preview download

session - Authenticated session to use to download with

Method Detail

getPage

public java.lang.Integer getPage()

setPage

public BoxRequestsPreview.DownloadPreview setPage(int pageNumber)

getMinWidth

public java.lang.Integer getMinWidth()

Gets the minimum width for the preview request. This is only relevant for image previews

Returns:

the minimum width of the thumbnail

setMinWidth

public BoxRequestsPreview.DownloadPreview setMinWidth(int width)

Sets the minimum width for the preview request. This is only relevant for image previews

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 preview request. This is only relevant for image previews

Returns:

the maximum width of the thumbnail

setMaxWidth

public BoxRequestsPreview.DownloadPreview setMaxWidth(int width)

Sets the maximum width for the preview request. This is only relevant for image previews.

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 preview request. This is only relevant for image previews

Returns:

the minimum height of the thumbnail

setMinHeight

public BoxRequestsPreview.DownloadPreview setMinHeight(int height)

Sets the minimum height for the preview request. This is only relevant for image previews.

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 preview request. This is only relevant for image previews

Returns:

the maximum height of the thumbnail

setMaxHeight

public BoxRequestsPreview.DownloadPreview setMaxHeight(int height)

Sets the maximum height for the preview request. This is only relevant for image previews.

Parameters:

height - int for the maximum height.

Returns:

request with the updated maximum height.

setMinSize

public BoxRequestsPreview.DownloadPreview setMinSize(int size)

Sets both the minimum height and minimum width for the preview request. This is only relevant for image previews.

Parameters:

size - int for the minimum height and minimum width.

Returns:

request with the updated minimum size.

setMaxSize

public BoxRequestsPreview.DownloadPreview setMaxSize(int size)

Sets both the maximum height and maximum width for the preview request. This is only relevant for image previews.

Parameters:

size - int for the maximum height and maximum width.

Returns:

request with the updated minimum size.