com.box.androidsdk.content.requests

Class BoxRequestsFile.UploadFile

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.UploadFile>

com.box.androidsdk.content.requests.BoxRequestsFile.UploadFile

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsFile

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

Request for uploading a new 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

Field Summary

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

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
UploadFile(java.io.File file, java.lang.String destinationFolderId, java.lang.String requestUrl, BoxSession session) Creates an upload file from file request with the default parameters
UploadFile(java.io.InputStream inputStream, java.lang.String fileName, java.lang.String destinationFolderId, java.lang.String requestUrl, BoxSession session) Creates an upload file from input stream request with the default parameters

Method Summary

Modifier and Type	Method and Description
protected com.box.androidsdk.content.requests.BoxRequestMultipart	createMultipartRequest()
java.lang.String	getDestinationFolderId() Returns the destination folder id for the uploaded file.
java.lang.String	getFileName() Returns the name of the file to upload.
BoxRequestsFile.UploadFile	setFileName(java.lang.String mFileName) Sets the name of the file to upload.

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

getId, onSendCompleted, setFields

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

buildUrl, createHeaderMap, createQuery, equals, getIfMatchEtag, getIfNoneMatchEtag, getRequestHandler, getSession, getSocket, getStringBody, handleSendForCachedResult, handleToTaskForCachedResult, handleUpdateCache, hashCode, importRequestContentMapsFrom, logDebug, logRequest, onSend, parseHashMapEntry, parseJsonObject, send, 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

UploadFile

public UploadFile(java.io.InputStream inputStream,
                  java.lang.String fileName,
                  java.lang.String destinationFolderId,
                  java.lang.String requestUrl,
                  BoxSession session)

Creates an upload file from input stream request with the default parameters

Parameters:

inputStream - input stream of the file

fileName - name of the new file

destinationFolderId - id of the parent folder for the new file

requestUrl - URL of the upload file endpoint

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

UploadFile

public UploadFile(java.io.File file,
                  java.lang.String destinationFolderId,
                  java.lang.String requestUrl,
                  BoxSession session)

Creates an upload file from file request with the default parameters

Parameters:

file - file to upload

destinationFolderId - id of the parent folder for the new file

requestUrl - URL of the upload file endpoint

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

Method Detail

createMultipartRequest

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

Overrides:

createMultipartRequest in class BoxRequestUpload<BoxFile,BoxRequestsFile.UploadFile>

Throws:

java.io.IOException

BoxException

getFileName

public java.lang.String getFileName()

Returns the name of the file to upload.

Returns:

name of the file to upload.

setFileName

public BoxRequestsFile.UploadFile setFileName(java.lang.String mFileName)

Sets the name of the file to upload.

Parameters:

mFileName - name of the file to upload.

Returns:

request with the updated file to upload.

getDestinationFolderId

public java.lang.String getDestinationFolderId()

Returns the destination folder id for the uploaded file.

Returns:

id of the destination folder for the uploaded file.