com.box.androidsdk.content.requests

Class BoxRequestsComment.GetCommentInfo

java.lang.Object

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

com.box.androidsdk.content.requests.BoxRequestItem<BoxComment,BoxRequestsComment.GetCommentInfo>

com.box.androidsdk.content.requests.BoxRequestsComment.GetCommentInfo

All Implemented Interfaces:

BoxCacheableRequest<BoxComment>, java.io.Serializable

Enclosing class:

BoxRequestsComment

public static class BoxRequestsComment.GetCommentInfo
extends BoxRequestItem<BoxComment,BoxRequestsComment.GetCommentInfo>
implements BoxCacheableRequest<BoxComment>

Request for retrieving information on a comment

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
GetCommentInfo(java.lang.String id, java.lang.String requestUrl, BoxSession session) Creates a comment information request with the default parameters

Method Summary

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

GetCommentInfo

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

Creates a comment information request with the default parameters

Parameters:

id - id of the comment to get information on

requestUrl - URL of the comment information endpoint

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

Method Detail

sendForCachedResult

public BoxComment sendForCachedResult()
                               throws BoxException

Description copied from interface: BoxCacheableRequest

Sends the request to fetch results from cache synchronously.

Specified by:

sendForCachedResult in interface BoxCacheableRequest<BoxComment>

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

Returns:

a task that will fetch the results from the cache

Throws:

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