com.box.androidsdk.content.requests

Class BoxRequestsCollections.GetCollections

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<BoxIteratorCollections,BoxRequestsCollections.GetCollections>

com.box.androidsdk.content.requests.BoxRequestsCollections.GetCollections

All Implemented Interfaces:

BoxCacheableRequest<BoxIteratorCollections>, java.io.Serializable

Enclosing class:

BoxRequestsCollections

public static class BoxRequestsCollections.GetCollections
extends BoxRequestList<BoxIteratorCollections,BoxRequestsCollections.GetCollections>
implements BoxCacheableRequest<BoxIteratorCollections>

Request to get the available collections.

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
GetCollections(java.lang.String collectionsUrl, BoxSession session) Creates a get collections request with the default parameters.

Method Summary

Modifier and Type	Method and Description
BoxIteratorCollections	sendForCachedResult() Sends the request to fetch results from cache synchronously.
BoxFutureTask<BoxIteratorCollections>	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.BoxRequestList

setLimit, setOffset

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

GetCollections

public GetCollections(java.lang.String collectionsUrl,
                      BoxSession session)

Creates a get collections request with the default parameters.

Parameters:

collectionsUrl - URL of the collections endpoint.

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

Method Detail

sendForCachedResult

public BoxIteratorCollections sendForCachedResult()
                                           throws BoxException

Description copied from interface: BoxCacheableRequest

Sends the request to fetch results from cache synchronously.

Specified by:

sendForCachedResult in interface BoxCacheableRequest<BoxIteratorCollections>

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<BoxIteratorCollections> 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<BoxIteratorCollections>

Returns:

a task that will fetch the results from the cache

Throws:

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