com.box.androidsdk.content.requests

Class BoxRequestsShare.GetPendingCollaborations

java.lang.Object

com.box.androidsdk.content.requests.BoxRequest<BoxIteratorCollaborations,BoxRequestsShare.GetPendingCollaborations>

com.box.androidsdk.content.requests.BoxRequestsShare.GetPendingCollaborations

All Implemented Interfaces:

BoxCacheableRequest<BoxIteratorCollaborations>, java.io.Serializable

Enclosing class:

BoxRequestsShare

public static class BoxRequestsShare.GetPendingCollaborations
extends BoxRequest<BoxIteratorCollaborations,BoxRequestsShare.GetPendingCollaborations>
implements BoxCacheableRequest<BoxIteratorCollaborations>

Request for retrieving pending collaborations for a user.

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.BoxRequest

JSON_OBJECT, mBodyMap, mContentType, mHeaderMap, mListener, mQueryMap, mRequestMethod, mRequestUrlString, mRequiresSocket, mSession, mTimeout

Constructor Summary

Constructors

Constructor and Description
GetPendingCollaborations(java.lang.String requestUrl, BoxSession session)

Method Summary

Modifier and Type	Method and Description
protected void	onSendCompleted(BoxResponse<BoxIteratorCollaborations> response) Post action that will be performed after a successful send occurs.
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.BoxRequest

buildUrl, createHeaderMap, 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

GetPendingCollaborations

public GetPendingCollaborations(java.lang.String requestUrl,
                                BoxSession session)

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.

onSendCompleted

protected void onSendCompleted(BoxResponse<BoxIteratorCollaborations> response)
                        throws BoxException

Description copied from class: BoxRequest

Post action that will be performed after a successful send occurs. Example useage would include updating the cache after a request is made

Overrides:

onSendCompleted in class BoxRequest<BoxIteratorCollaborations,BoxRequestsShare.GetPendingCollaborations>

Parameters:

response - response of the BoxRequest

Throws:

BoxException - thrown if there was a problem with handling the request.