com.box.androidsdk.content.requests

Class BoxRequestsFile.GetFileComments

java.lang.Object

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

com.box.androidsdk.content.requests.BoxRequestItem<BoxIteratorComments,BoxRequestsFile.GetFileComments>

com.box.androidsdk.content.requests.BoxRequestsFile.GetFileComments

All Implemented Interfaces:

BoxCacheableRequest<BoxIteratorComments>, java.io.Serializable

Enclosing class:

BoxRequestsFile

public static class BoxRequestsFile.GetFileComments
extends BoxRequestItem<BoxIteratorComments,BoxRequestsFile.GetFileComments>
implements BoxCacheableRequest<BoxIteratorComments>

Request for getting comments on a file

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

Field Summary

Fields inherited from class com.box.androidsdk.content.requests.BoxRequestItem

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
GetFileComments(java.lang.String id, java.lang.String requestUrl, BoxSession session) Creates a get file comments request with the default parameters

Method Summary

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

getId, onSendCompleted, setFields

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

GetFileComments

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

Creates a get file comments request with the default parameters

Parameters:

id - id of the file to get comments of

requestUrl - URL of the file comments endpoint

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

Method Detail

sendForCachedResult

public BoxIteratorComments sendForCachedResult()
                                        throws BoxException

Description copied from interface: BoxCacheableRequest

Sends the request to fetch results from cache synchronously.

Specified by:

sendForCachedResult in interface BoxCacheableRequest<BoxIteratorComments>

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

Returns:

a task that will fetch the results from the cache

Throws:

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