com.box.androidsdk.content.requests

Class BoxRequestItem<E extends BoxJsonObject,R extends BoxRequest<E,R>>

java.lang.Object

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

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

Type Parameters:

E - type of BoxJsonObject that is returned in the response.

R - type of BoxRequest being created.

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BoxRequestCollectionUpdate, BoxRequestItemUpdate, BoxRequestList, BoxRequestsBookmark.AddCommentToBookmark, BoxRequestsBookmark.CopyBookmark, BoxRequestsBookmark.CreateBookmark, BoxRequestsBookmark.GetBookmarkComments, BoxRequestsBookmark.GetBookmarkInfo, BoxRequestsBookmark.GetTrashedBookmark, BoxRequestsBookmark.RestoreTrashedBookmark, BoxRequestsComment.AddReplyComment, BoxRequestsComment.GetCommentInfo, BoxRequestsFile.AddCommentToFile, BoxRequestsFile.AddTaggedCommentToFile, BoxRequestsFile.CopyFile, BoxRequestsFile.GetCollaborations, BoxRequestsFile.GetEmbedLinkFileInfo, BoxRequestsFile.GetFileComments, BoxRequestsFile.GetFileInfo, BoxRequestsFile.GetFileVersions, BoxRequestsFile.GetTrashedFile, BoxRequestsFile.PromoteFileVersion, BoxRequestsFile.RestoreTrashedFile, BoxRequestsFolder.CopyFolder, BoxRequestsFolder.CreateFolder, BoxRequestsFolder.GetCollaborations, BoxRequestsFolder.GetFolderInfo, BoxRequestsFolder.GetFolderItems, BoxRequestsFolder.GetFolderWithAllItems, BoxRequestsFolder.GetTrashedFolder, BoxRequestsFolder.RestoreTrashedFolder, BoxRequestsSearch.Search, BoxRequestsShare.GetSharedLink, BoxRequestsUser.CreateEnterpriseUser, BoxRequestsUser.GetEnterpriseUsers, BoxRequestsUser.GetUserInfo, BoxRequestsUser.UpdateUserInformation, BoxRequestUpload

public abstract class BoxRequestItem<E extends BoxJsonObject,R extends BoxRequest<E,R>>
extends BoxRequest<E,R>

Abstract class that represents a request which returns an item in the response.

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

Modifier and Type	Field and Description
protected java.lang.StringBuffer	mHintHeader
protected java.lang.String	mId
protected static java.lang.String	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

Modifier	Constructor and Description
protected	BoxRequestItem(BoxRequestItem r)
	BoxRequestItem(java.lang.Class<E> clazz, java.lang.String id, java.lang.String requestUrl, BoxSession session) Constructs a BoxRequestItem with the default parameters.

Method Summary

Modifier and Type	Method and Description
R	addRepresentationHintGroup(java.lang.String... hints) Include a representation hint group into this request.
protected void	createHeaderMap()
java.lang.String	getId() Returns the id of the Box item being modified.
protected void	onSendCompleted(BoxResponse<E> response) Post action that will be performed after a successful send occurs.
R	setFields(java.lang.String... fields) Sets the fields to return in the response.

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

Field Detail

QUERY_FIELDS

protected static java.lang.String QUERY_FIELDS

mId

protected java.lang.String mId

mHintHeader

protected java.lang.StringBuffer mHintHeader

Constructor Detail

BoxRequestItem

public BoxRequestItem(java.lang.Class<E> clazz,
                      java.lang.String id,
                      java.lang.String requestUrl,
                      BoxSession session)

Constructs a BoxRequestItem with the default parameters.

Parameters:

clazz - class of the object returned in the response.

id - id of the object.

requestUrl - URL of the endpoint for the request.

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

BoxRequestItem

protected BoxRequestItem(BoxRequestItem r)

Method Detail

setFields

public R setFields(java.lang.String... fields)

Sets the fields to return in the response.

Parameters:

fields - fields to return in the response.

Returns:

request with the updated fields.

addRepresentationHintGroup

public R addRepresentationHintGroup(java.lang.String... hints)

Include a representation hint group into this request. Please refer to representation documentation for more details

Parameters:

hints - string list with all the representation hints

Returns:

request with updated hint group

createHeaderMap

protected void createHeaderMap()

Overrides:

createHeaderMap in class BoxRequest<E extends BoxJsonObject,R extends BoxRequest<E,R>>

getId

public java.lang.String getId()

Returns the id of the Box item being modified.

Returns:

the id of the Box item that this request is attempting to modify.

onSendCompleted

protected void onSendCompleted(BoxResponse<E> 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<E extends BoxJsonObject,R extends BoxRequest<E,R>>

Parameters:

response - response of the BoxRequest

Throws:

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