com.box.androidsdk.content.requests

Class BoxRequestsFile.DownloadRepresentation

java.lang.Object

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

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

com.box.androidsdk.content.requests.BoxRequestsFile.DownloadRepresentation

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsFile

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

See Also:

Serialized Form

Nested Class Summary

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, BoxRequest.TLSSSLSocketFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected BoxRepresentation	mRepresentation
protected int	mRequestPage The page number to retrieve in case the representation is paged.

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
DownloadRepresentation(java.lang.String id, java.io.File target, BoxRepresentation representation, BoxSession session)

Method Summary

Modifier and Type	Method and Description
protected java.net.URL	buildUrl()
boolean	isPaged() Returns whether this request supports specifying a page
void	setRequestedPage(int page) Define which representation page to request (if supported on this representation) Please refer to isPaged() to check whether this request supports multiple pages

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

getId, getRangeEnd, getRangeStart, getSha1, getTarget, getTargetStream, getVersion, logDebug, setContentAccess, setDownloadStartListener, setHeaders, setProgressListener, setRange, setSha1, 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

mRepresentation

protected BoxRepresentation mRepresentation

mRequestPage

protected int mRequestPage

The page number to retrieve in case the representation is paged. If page is required and not provided, retrieve page 1 as default

Constructor Detail

DownloadRepresentation

public DownloadRepresentation(java.lang.String id,
                              java.io.File target,
                              BoxRepresentation representation,
                              BoxSession session)

Method Detail

buildUrl

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

Overrides:

buildUrl in class BoxRequest<BoxDownload,BoxRequestsFile.DownloadRepresentation>

Throws:

java.net.MalformedURLException

java.io.UnsupportedEncodingException

isPaged

public boolean isPaged()

Returns whether this request supports specifying a page

Returns:

whether this representation is paged

setRequestedPage

public void setRequestedPage(int page)

Define which representation page to request (if supported on this representation) Please refer to isPaged() to check whether this request supports multiple pages

Parameters:

page - the representation page # to be downloaded