com.box.sdk

Class BoxFileUploadSession.Info

Object

BoxJSONObject

BoxResource.Info

BoxFileUploadSession.Info

Enclosing class:

BoxFileUploadSession

public class BoxFileUploadSession.Info
extends BoxResource.Info

Model contains the upload session information.

Constructor Summary

Constructors

Constructor and Description
Info(String json) Constructs an Info object by parsing information from a JSON string.

Method Summary

Modifier and Type	Method and Description
int	getPartSize() Returns the size of the each part.
int	getPartsProcessed() Returns the parts that are processed so for.
BoxFileUploadSession	getResource() Returns the BoxFileUploadSession isntance to which this object belongs to.
BoxFileUploadSession.Endpoints	getSessionEndpoints() Returns the session endpoints that can be called for this upload session.
Date	getSessionExpiresAt() Returns the date and time at which the upload session expires.
int	getTotalParts() Returns the total parts of the file that is uploaded in the upload session.
String	getUploadSessionId() Returns the upload session id.
protected void	parseJSONMember(JsonObject.Member member) Invoked with a JSON member whenever this object is updated or created from a JSON object.

Methods inherited from class BoxResource.Info

getID

Methods inherited from class BoxJSONObject

clearPendingChanges, getJson, getPendingChanges, getPendingChangesAsJsonObject

Methods inherited from class Object

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

Constructor Detail

Info

public Info(String json)

Constructs an Info object by parsing information from a JSON string.

Parameters:

json - the JSON string to parse.

Method Detail

getResource

public BoxFileUploadSession getResource()

Returns the BoxFileUploadSession isntance to which this object belongs to.

Specified by:

getResource in class BoxResource.Info

Returns:

the instance of upload session.

getTotalParts

public int getTotalParts()

Returns the total parts of the file that is uploaded in the upload session.

Returns:

the total number of parts.

getPartsProcessed

public int getPartsProcessed()

Returns the parts that are processed so for.

Returns:

the number of the processed parts.

getSessionExpiresAt

public Date getSessionExpiresAt()

Returns the date and time at which the upload session expires.

Returns:

the date and time in UTC format.

getUploadSessionId

public String getUploadSessionId()

Returns the upload session id.

Returns:

the id string.

getSessionEndpoints

public BoxFileUploadSession.Endpoints getSessionEndpoints()

Returns the session endpoints that can be called for this upload session.

Returns:

the Endpoints instance.

getPartSize

public int getPartSize()

Returns the size of the each part. Only the last part of the file can be lessor than this value.

Returns:

the part size.

parseJSONMember

protected void parseJSONMember(JsonObject.Member member)

Description copied from class: BoxJSONObject

Invoked with a JSON member whenever this object is updated or created from a JSON object.

Subclasses should override this method in order to parse any JSON members it knows about. This method is a no-op by default.

Parameters:

member - the JSON member to be parsed.