com.box.androidsdk.content.requests

Class BoxRequestsFile.UploadNewVersion

java.lang.Object

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

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

com.box.androidsdk.content.requests.BoxRequestUpload<BoxFile,BoxRequestsFile.UploadNewVersion>

com.box.androidsdk.content.requests.BoxRequestsFile.UploadNewVersion

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsFile

public static class BoxRequestsFile.UploadNewVersion
extends BoxRequestUpload<BoxFile,BoxRequestsFile.UploadNewVersion>

Request for uploading a new version of a file

See Also:

Serialized Form

Nested Class Summary

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

BoxRequestUpload.UploadRequestHandler

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 inherited from class com.box.androidsdk.content.requests.BoxRequestItem

mHintHeader, mId, QUERY_FIELDS

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
UploadNewVersion(java.io.InputStream fileInputStream, java.lang.String requestUrl, BoxSession session) Creates an upload new file version request with the default parameters

Method Summary

Modifier and Type	Method and Description
protected com.box.androidsdk.content.requests.BoxRequestMultipart	createMultipartRequest()
java.lang.String	getIfMatchEtag() Returns the etag currently set in the if-match header.
void	setFileName(java.lang.String newFileName) Set the file name of the new uploaded version.
BoxRequestsFile.UploadNewVersion	setIfMatchEtag(java.lang.String etag) Sets the if-match header for the request.

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

createHttpRequest, getCreatedDate, getFile, getInputStream, getModifiedDate, getSha1, getUploadSize, sendRequest, setCreatedDate, setHeaders, setModifiedDate, setProgressListener, setSha1, setUploadSize

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

addRepresentationHintGroup, createHeaderMap, getId, onSendCompleted, setFields

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

buildUrl, createQuery, equals, getIfNoneMatchEtag, getRequestHandler, getSession, getSocket, getStringBody, handleSendForCachedResult, handleToTaskForCachedResult, handleUpdateCache, hashCode, importRequestContentMapsFrom, logDebug, logRequest, onSend, parseHashMapEntry, parseJsonObject, send, setBody, setContentType, setIfNoneMatchEtag, setRequestHandler, setTimeOut, toTask

Methods inherited from class java.lang.Object

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

Constructor Detail

UploadNewVersion

public UploadNewVersion(java.io.InputStream fileInputStream,
                        java.lang.String requestUrl,
                        BoxSession session)

Creates an upload new file version request with the default parameters

Parameters:

fileInputStream - input stream of the new file version

requestUrl - URL of the upload new version endpoint

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

Method Detail

setIfMatchEtag

public BoxRequestsFile.UploadNewVersion setIfMatchEtag(java.lang.String etag)

Sets the if-match header for the request. The new version will only be uploaded if the specified etag matches the most current etag for the file.

Overrides:

setIfMatchEtag in class BoxRequest<BoxFile,BoxRequestsFile.UploadNewVersion>

Parameters:

etag - etag to set in the if-match header.

Returns:

request with the updated if-match header.

getIfMatchEtag

public java.lang.String getIfMatchEtag()

Returns the etag currently set in the if-match header.

Overrides:

getIfMatchEtag in class BoxRequest<BoxFile,BoxRequestsFile.UploadNewVersion>

Returns:

etag set in the if-match header, or null if none set.

setFileName

public void setFileName(java.lang.String newFileName)

Set the file name of the new uploaded version.

createMultipartRequest

protected com.box.androidsdk.content.requests.BoxRequestMultipart createMultipartRequest()
                                                                                  throws java.io.IOException,
                                                                                         BoxException

Overrides:

createMultipartRequest in class BoxRequestUpload<BoxFile,BoxRequestsFile.UploadNewVersion>

Throws:

java.io.IOException

BoxException