com.box.androidsdk.preview.ext

Class BoxRequestsPreview.PreviewBatchRequest

java.lang.Object

com.box.androidsdk.content.requests.BoxRequest<com.box.androidsdk.content.requests.BoxResponseBatch,com.box.androidsdk.content.requests.BoxRequestBatch>

com.box.androidsdk.content.requests.BoxRequestBatch

com.box.androidsdk.preview.ext.BoxRequestsPreview.PreviewBatchRequest

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsPreview

public static class BoxRequestsPreview.PreviewBatchRequest
extends com.box.androidsdk.content.requests.BoxRequestBatch

This class contains a set of invidual tasks related to downloading a preview for a given file.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	BoxRequestsPreview.PreviewBatchRequest.WrapperProgressListener

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, com.box.androidsdk.content.requests.BoxRequest.TLSSSLSocketFactory

Field Summary

Fields

Modifier and Type	Field and Description
protected int	mMainDownloadIndex
protected BoxRequestsPreview.PreviewBatchRequest.WrapperProgressListener	mWrapperListener

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

mRequests

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
PreviewBatchRequest()

Method Summary

Modifier and Type	Method and Description
com.box.androidsdk.content.requests.BoxRequestBatch	addMainDownloadRequest(com.box.androidsdk.content.requests.BoxRequestDownload request) Adds the request mainly responsible for downloading the required content.
int	getMainDownloadIndex() Get the index for the main download.
com.box.androidsdk.content.requests.BoxRequestDownload	getMainDownloadRequest() If set the request that acts as the main download request.
boolean	hasMainDownloadRequest()
BoxRequestsPreview.PreviewBatchRequest	setDownloadStartListener(com.box.androidsdk.content.listeners.DownloadStartListener listener) Sets the download start listener for the main download request.
protected void	setMandatoryProgressListener(com.box.androidsdk.content.listeners.ProgressListener listener) Sets a progress listener that will not be overwritten by setProgressListener.
BoxRequestsPreview.PreviewBatchRequest	setProgressListener(com.box.androidsdk.content.listeners.ProgressListener listener) Sets the progress listener for the main download request.

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

addRequest, onSend, setExecutor

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, logDebug, logRequest, onSendCompleted, parseHashMapEntry, parseJsonObject, send, sendRequest, setBody, setContentType, setHeaders, setIfMatchEtag, setIfNoneMatchEtag, setRequestHandler, setTimeOut, toTask

Methods inherited from class java.lang.Object

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

Field Detail

mMainDownloadIndex

protected int mMainDownloadIndex

mWrapperListener

protected BoxRequestsPreview.PreviewBatchRequest.WrapperProgressListener mWrapperListener

Constructor Detail

PreviewBatchRequest

public PreviewBatchRequest()

Method Detail

addMainDownloadRequest

public com.box.androidsdk.content.requests.BoxRequestBatch addMainDownloadRequest(com.box.androidsdk.content.requests.BoxRequestDownload request)

Adds the request mainly responsible for downloading the required content.

Parameters:

request - the download request.

Returns:

the current PreviewBatchRequest.

getMainDownloadRequest

public com.box.androidsdk.content.requests.BoxRequestDownload getMainDownloadRequest()

If set the request that acts as the main download request.

Returns:

the request responsible for downloading the majority of the content.

setProgressListener

public BoxRequestsPreview.PreviewBatchRequest setProgressListener(com.box.androidsdk.content.listeners.ProgressListener listener)

Sets the progress listener for the main download request.

Parameters:

listener - progress listener for the download.

Returns:

this download request.

setMandatoryProgressListener

protected void setMandatoryProgressListener(com.box.androidsdk.content.listeners.ProgressListener listener)

Sets a progress listener that will not be overwritten by setProgressListener.

Parameters:

listener - A listener that will not be overwritten by setProgressListener.

setDownloadStartListener

public BoxRequestsPreview.PreviewBatchRequest setDownloadStartListener(com.box.androidsdk.content.listeners.DownloadStartListener listener)

Sets the download start listener for the main download request.

Parameters:

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

Returns:

this download request object.

hasMainDownloadRequest

public boolean hasMainDownloadRequest()

Returns:

true if a main download request has been set, false otherwise.

getMainDownloadIndex

public int getMainDownloadIndex()

Get the index for the main download.

Returns:

the main download index.