com.box.androidsdk.content.requests

Class BoxRequestsFile.PromoteFileVersion

java.lang.Object

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

com.box.androidsdk.content.requests.BoxRequestItem<BoxFileVersion,BoxRequestsFile.PromoteFileVersion>

com.box.androidsdk.content.requests.BoxRequestsFile.PromoteFileVersion

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsFile

public static class BoxRequestsFile.PromoteFileVersion
extends BoxRequestItem<BoxFileVersion,BoxRequestsFile.PromoteFileVersion>

Request for promoting an old version to the top of the version stack for a 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.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
PromoteFileVersion(java.lang.String id, java.lang.String versionId, java.lang.String requestUrl, BoxSession session) Creates a promote file version request with the default parameters

Method Summary

Modifier and Type	Method and Description
protected void	onSendCompleted(BoxResponse<BoxFileVersion> response) Post action that will be performed after a successful send occurs.
BoxRequestsFile.PromoteFileVersion	setVersionId(java.lang.String versionId) Sets the id of the version to promote.

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

addRepresentationHintGroup, createHeaderMap, getId, setFields

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

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

PromoteFileVersion

public PromoteFileVersion(java.lang.String id,
                          java.lang.String versionId,
                          java.lang.String requestUrl,
                          BoxSession session)

Creates a promote file version request with the default parameters

Parameters:

id - id of the file to promote a version of

versionId - id of the version to promote to the top

requestUrl - URL of the promote file version endpoint

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

Method Detail

setVersionId

public BoxRequestsFile.PromoteFileVersion setVersionId(java.lang.String versionId)

Sets the id of the version to promote.

Parameters:

versionId - id of the version to promote.

Returns:

request with the updated version id.

onSendCompleted

protected void onSendCompleted(BoxResponse<BoxFileVersion> 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 BoxRequestItem<BoxFileVersion,BoxRequestsFile.PromoteFileVersion>

Parameters:

response - response of the BoxRequest

Throws:

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