com.box.androidsdk.content.requests

Class BoxRequestsFile.DownloadFile

java.lang.Object

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

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

com.box.androidsdk.content.requests.BoxRequestsFile.DownloadFile

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsFile

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

Request for downloading a file

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

Field Summary

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
DownloadFile(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
DownloadFile(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
DownloadFile(java.lang.String id, java.io.File target, java.lang.String requestUrl, BoxSession session) Creates a download file to file request with the default parameters
DownloadFile(java.lang.String id, java.io.OutputStream outputStream, java.lang.String requestUrl, BoxSession session) Creates a download file to output stream request with the default parameters

Method Summary

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

getId, getRangeEnd, getRangeStart, getTarget, getTargetStream, getVersion, logDebug, setContentAccess, 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

Constructor Detail

DownloadFile

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

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

Parameters:

id - The id of the file to download

outputStream - The output stream to download the file to

requestUrl - URL of the download file endpoint

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

DownloadFile

@Deprecated
public DownloadFile(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 file to output stream request with the default parameters

Parameters:

outputStream - The output stream to download the file to

requestUrl - URL of the download file endpoint

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

DownloadFile

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

Creates a download file to file request with the default parameters

Parameters:

id - The Id of the file to download

target - The target file to download to

requestUrl - URL of the download file endpoint

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

DownloadFile

@Deprecated
public DownloadFile(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 file to file request with the default parameters

Parameters:

target - Target file to download to

requestUrl - URL of the download file endpoint

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