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.

Direct Known Subclasses:

BoxRequestItemUpdate, BoxRequestsBookmark.AddBookmarkToCollection, BoxRequestsBookmark.AddCommentToBookmark, BoxRequestsBookmark.CopyBookmark, BoxRequestsBookmark.CreateBookmark, BoxRequestsBookmark.DeleteBookmarkFromCollection, BoxRequestsBookmark.GetBookmarkComments, BoxRequestsBookmark.GetBookmarkInfo, BoxRequestsBookmark.GetTrashedBookmark, BoxRequestsBookmark.RestoreTrashedBookmark, BoxRequestsCollections.GetCollectionItems, BoxRequestsCollections.GetCollections, BoxRequestsComment.AddReplyComment, BoxRequestsComment.GetCommentInfo, BoxRequestsFile.AddCommentToFile, BoxRequestsFile.AddFileToCollection, BoxRequestsFile.CopyFile, BoxRequestsFile.DeleteFileFromCollection, BoxRequestsFile.GetFileComments, BoxRequestsFile.GetFileInfo, BoxRequestsFile.GetFileVersions, BoxRequestsFile.GetTrashedFile, BoxRequestsFile.PromoteFileVersion, BoxRequestsFile.RestoreTrashedFile, BoxRequestsFolder.AddFolderToCollection, BoxRequestsFolder.CopyFolder, BoxRequestsFolder.CreateFolder, BoxRequestsFolder.DeleteFolderFromCollection, BoxRequestsFolder.GetCollaborations, BoxRequestsFolder.GetFolderInfo, BoxRequestsFolder.GetFolderItems, BoxRequestsFolder.GetTrashedFolder, BoxRequestsFolder.RestoreTrashedFolder, BoxRequestsUser.CreateEnterpriseUser, BoxRequestsUser.GetEnterpriseUsers, BoxRequestsUser.GetUserInfo, BoxRequestsUser.UpdateUserInformation

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.

Nested Class Summary

Nested classes/interfaces inherited from class com.box.androidsdk.content.requests.BoxRequest

BoxRequest.BoxRequestHandler, BoxRequest.ContentTypes, BoxRequest.Methods

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	mId

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

mBodyMap, mContentType, mHeaderMap, mListener, mQueryMap, mRequestMethod, mRequestUrlString, mSession

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

Methods

Modifier and Type	Method and Description
java.lang.String	getId() Returns the id of the Box item being modified.
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, getIfMatchEtag, getIfNoneMatchEtag, getRequestHandler, getSession, getStringBody, importRequestContentMapsFrom, logDebug, parseHashMapEntry, parseJsonObject, send, setBody, setContentType, setHeaders, setIfMatchEtag, setIfNoneMatchEtag, setRequestHandler, setTimeOut, toTask

Methods inherited from class java.lang.Object

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

Field Detail

mId

protected java.lang.String mId

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.

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.