com.box.androidsdk.content.requests

Class BoxRequestList<E extends BoxIterator,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.BoxRequestList<E,R>

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BoxRequestRecentItems.GetRecentItems, BoxRequestsCollections.GetCollectionItems, BoxRequestsCollections.GetCollections

public abstract class BoxRequestList<E extends BoxIterator,R extends BoxRequest<E,R>>
extends BoxRequestItem<E,R>

Request for getting a list of items.

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
BoxRequestList(java.lang.Class<E> clazz, java.lang.String id, java.lang.String requestUrl, BoxSession session) Creates a list request with the default parameters

Method Summary

Modifier and Type	Method and Description
R	setLimit(int limit) Sets the limit of items that should be returned
R	setOffset(int offset) Sets the offset of the items that should be returned

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

Constructor Detail

BoxRequestList

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

Creates a list request with the default parameters

Parameters:

clazz - class of the object returned in the response.

id - id of the list to get the items of

requestUrl - URL of the list items endpoint

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

Method Detail

setLimit

public R setLimit(int limit)

Sets the limit of items that should be returned

Parameters:

limit - limit of items to return

Returns:

the get folder items request

setOffset

public R setOffset(int offset)

Sets the offset of the items that should be returned

Parameters:

offset - offset of items to return

Returns:

the offset of the items to return