com.box.androidsdk.content.requests

Class BoxRequestCollectionUpdate<E extends BoxItem,R extends BoxRequest<E,R>>

java.lang.Object

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

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

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

Type Parameters:

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

R - type of BoxRequest that is being created.

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BoxRequestsBookmark.AddBookmarkToCollection, BoxRequestsBookmark.DeleteBookmarkFromCollection, BoxRequestsFile.AddFileToCollection, BoxRequestsFile.DeleteFileFromCollection, BoxRequestsFolder.AddFolderToCollection, BoxRequestsFolder.DeleteFolderFromCollection

public abstract class BoxRequestCollectionUpdate<E extends BoxItem,R extends BoxRequest<E,R>>
extends BoxRequestItem<E,R>

Abstract class that represents a request to update a collection's contents by adding or removing an item.

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 static java.lang.String	FIELD_COLLECTIONS

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
BoxRequestCollectionUpdate(java.lang.Class<E> clazz, java.lang.String id, java.lang.String requestUrl, BoxSession session) Constructs an update collection request with the default parameters.

Method Summary

Modifier and Type	Method and Description
protected R	setCollectionId(java.lang.String id) Sets the id of the collection to update.

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

addRepresentationHintGroup, createHeaderMap, getId, onSendCompleted, 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

Field Detail

FIELD_COLLECTIONS

protected static final java.lang.String FIELD_COLLECTIONS

See Also:

Constant Field Values

Constructor Detail

BoxRequestCollectionUpdate

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

Constructs an update collection request with the default parameters.

Parameters:

clazz - class of the BoxItem returned in the response.

id - id of the item to add to/remove from a collection.

requestUrl - URL of the update collection endpoint.

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

Method Detail

setCollectionId

protected R setCollectionId(java.lang.String id)

Sets the id of the collection to update.

Parameters:

id - id of the collection to update.

Returns:

request with the updated collection id.