com.box.androidsdk.content.requests

Class BoxRequestsFolder.GetCollaborations

java.lang.Object

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

com.box.androidsdk.content.requests.BoxRequestItem<BoxIteratorCollaborations,BoxRequestsFolder.GetCollaborations>

com.box.androidsdk.content.requests.BoxRequestsFolder.GetCollaborations

All Implemented Interfaces:

BoxCacheableRequest<BoxIteratorCollaborations>, java.io.Serializable

Enclosing class:

BoxRequestsFolder

public static class BoxRequestsFolder.GetCollaborations
extends BoxRequestItem<BoxIteratorCollaborations,BoxRequestsFolder.GetCollaborations>
implements BoxCacheableRequest<BoxIteratorCollaborations>

Request for getting the collaborations of a folder

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
GetCollaborations(java.lang.String id, java.lang.String requestUrl, BoxSession session) Creates a request that gets the collaborations of a folder with the default parameters

Method Summary

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

GetCollaborations

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

Creates a request that gets the collaborations of a folder with the default parameters

Parameters:

id - id of the folder to get collaborations on

requestUrl - URL of the folder collaborations endpoint

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

Method Detail

sendForCachedResult

public BoxIteratorCollaborations sendForCachedResult()
                                              throws BoxException

Description copied from interface: BoxCacheableRequest

Sends the request to fetch results from cache synchronously.

Specified by:

sendForCachedResult in interface BoxCacheableRequest<BoxIteratorCollaborations>

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

Returns:

a task that will fetch the results from the cache

Throws:

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