com.box.androidsdk.content.requests

Class BoxRequestsFolder.GetFolderItems

java.lang.Object

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

com.box.androidsdk.content.requests.BoxRequestItem<BoxIteratorItems,BoxRequestsFolder.GetFolderItems>

com.box.androidsdk.content.requests.BoxRequestsFolder.GetFolderItems

All Implemented Interfaces:

BoxCacheableRequest<BoxIteratorItems>, java.io.Serializable

Enclosing class:

BoxRequestsFolder

public static class BoxRequestsFolder.GetFolderItems
extends BoxRequestItem<BoxIteratorItems,BoxRequestsFolder.GetFolderItems>
implements BoxCacheableRequest<BoxIteratorItems>

Request for getting a folders 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
GetFolderItems(java.lang.String id, java.lang.String requestUrl, BoxSession session) Creates a folder information request with the default parameters

Method Summary

Modifier and Type	Method and Description
BoxIteratorItems	sendForCachedResult() Sends the request to fetch results from cache synchronously.
BoxRequestsFolder.GetFolderItems	setLimit(int limit) Sets the limit of items that should be returned
BoxRequestsFolder.GetFolderItems	setOffset(int offset) Sets the offset of the items that should be returned
BoxFutureTask<BoxIteratorItems>	toTaskForCachedResult() Converts the request to a BoxCacheFutureTask that can be used to execute the request asynchronously.

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

GetFolderItems

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

Creates a folder information request with the default parameters

Parameters:

id - id of the folder to get the items of

requestUrl - URL of the folder items endpoint

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

Method Detail

setLimit

public BoxRequestsFolder.GetFolderItems 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 BoxRequestsFolder.GetFolderItems 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

sendForCachedResult

public BoxIteratorItems sendForCachedResult()
                                     throws BoxException

Description copied from interface: BoxCacheableRequest

Sends the request to fetch results from cache synchronously.

Specified by:

sendForCachedResult in interface BoxCacheableRequest<BoxIteratorItems>

Returns:

the cached results of the request

Throws:

BoxException - thrown if there is no implementation of BoxCache set in BoxConfig, or if there was another issue getting cached results.

toTaskForCachedResult

public BoxFutureTask<BoxIteratorItems> toTaskForCachedResult()
                                                      throws BoxException

Description copied from interface: BoxCacheableRequest

Converts the request to a BoxCacheFutureTask that can be used to execute the request asynchronously.

Specified by:

toTaskForCachedResult in interface BoxCacheableRequest<BoxIteratorItems>

Returns:

a task that will fetch the results from the cache

Throws:

BoxException - thrown if there is no implementation of BoxCache set in BoxConfig.