com.box.androidsdk.content.requests

Class BoxRequestsFile.CreateUploadSession

java.lang.Object

com.box.androidsdk.content.requests.BoxRequest<BoxUploadSession,BoxRequestsFile.CreateUploadSession>

com.box.androidsdk.content.requests.BoxRequestsFile.CreateUploadSession

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsFile

public static class BoxRequestsFile.CreateUploadSession
extends BoxRequest<BoxUploadSession,BoxRequestsFile.CreateUploadSession>

Request for creating a chunked upload session for a new file

See Also:

Serialized Form

Nested Class Summary

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

JSON_OBJECT, mBodyMap, mContentType, mHeaderMap, mListener, mQueryMap, mRequestMethod, mRequestUrlString, mRequiresSocket, mSession, mTimeout

Constructor Summary

Constructors

Constructor and Description
CreateUploadSession(java.io.File file, java.lang.String destinationFolderId, java.lang.String requestUrl, BoxSession session) Creates an upload file session with the default parameters
CreateUploadSession(java.io.InputStream is, java.lang.String fileName, long fileSize, java.lang.String destinationFolderId, java.lang.String requestUrl, BoxSession session) Creates an upload file session with the default parameters

Method Summary

Modifier and Type	Method and Description
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.
long	getFileSize() Returns the size of the file to upload
protected void	onSendCompleted(BoxResponse<BoxUploadSession> response) Post action that will be performed after a successful send occurs.
void	setFileName(java.lang.String mFileName) Set file name of the file to upload

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, onSend, 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

Constructor Detail

CreateUploadSession

public CreateUploadSession(java.io.File file,
                           java.lang.String destinationFolderId,
                           java.lang.String requestUrl,
                           BoxSession session)
                    throws java.io.FileNotFoundException

Creates an upload file session 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

Throws:

java.io.FileNotFoundException

CreateUploadSession

public CreateUploadSession(java.io.InputStream is,
                           java.lang.String fileName,
                           long fileSize,
                           java.lang.String destinationFolderId,
                           java.lang.String requestUrl,
                           BoxSession session)

Creates an upload file session with the default parameters

Parameters:

is - the inputStream from where to read the file data

fileName - the new file name

fileSize - the file size

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

onSendCompleted

protected void onSendCompleted(BoxResponse<BoxUploadSession> response)
                        throws BoxException

Description copied from class: BoxRequest

Post action that will be performed after a successful send occurs. Example useage would include updating the cache after a request is made

Overrides:

onSendCompleted in class BoxRequest<BoxUploadSession,BoxRequestsFile.CreateUploadSession>

Parameters:

response - response of the BoxRequest

Throws:

BoxException - thrown if there was a problem with handling the request.

setFileName

public void setFileName(java.lang.String mFileName)

Set file name of the file to upload

Parameters:

mFileName -

getFileName

public java.lang.String getFileName()

Returns the name of the file to upload.

Returns:

name of the file to upload.

getFileSize

public long getFileSize()

Returns the size of the file to upload

Returns:

file size in bytes

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.