com.box.androidsdk.content.requests

Class BoxRequestsFolder.GetFolderInfo

java.lang.Object

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

com.box.androidsdk.content.requests.BoxRequestItem<BoxFolder,BoxRequestsFolder.GetFolderInfo>

com.box.androidsdk.content.requests.BoxRequestsFolder.GetFolderInfo

All Implemented Interfaces:

BoxCacheableRequest<BoxFolder>, java.io.Serializable

Enclosing class:

BoxRequestsFolder

public static class BoxRequestsFolder.GetFolderInfo
extends BoxRequestItem<BoxFolder,BoxRequestsFolder.GetFolderInfo>
implements BoxCacheableRequest<BoxFolder>

Request for retrieving information on 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
GetFolderInfo(java.lang.String id, java.lang.String requestUrl, BoxSession session) Creates a folder information request with the default parameters

Method Summary

Modifier and Type	Method and Description
java.lang.String	getIfNoneMatchEtag() Returns the etag currently set in the if-none-match header.
BoxFolder	sendForCachedResult() Sends the request to fetch results from cache synchronously.
BoxRequestsFolder.GetFolderInfo	setIfNoneMatchEtag(java.lang.String etag) Sets the if-none-match header for the request.
BoxRequestsFolder.GetFolderInfo	setLimit(int limit) Sets the limit of items that should be returned
BoxRequestsFolder.GetFolderInfo	setOffset(int offset) Sets the offset of the items that should be returned
BoxFutureTask<BoxFolder>	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, getRequestHandler, getSession, getSocket, getStringBody, handleSendForCachedResult, handleToTaskForCachedResult, handleUpdateCache, hashCode, importRequestContentMapsFrom, logDebug, logRequest, onSend, parseHashMapEntry, parseJsonObject, send, sendRequest, setBody, setContentType, setHeaders, setIfMatchEtag, setRequestHandler, setTimeOut, toTask

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GetFolderInfo

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

Creates a folder information request with the default parameters

Parameters:

id - id of the folder to get information on

requestUrl - URL of the folder information endpoint

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

Method Detail

setIfNoneMatchEtag

public BoxRequestsFolder.GetFolderInfo setIfNoneMatchEtag(java.lang.String etag)

Sets the if-none-match header for the request. The folder will only be retrieved if the etag does not match the most current etag for the folder.

Overrides:

setIfNoneMatchEtag in class BoxRequest<BoxFolder,BoxRequestsFolder.GetFolderInfo>

Parameters:

etag - etag to set in the if-none-match header.

Returns:

request with the updated if-none-match header.

getIfNoneMatchEtag

public java.lang.String getIfNoneMatchEtag()

Returns the etag currently set in the if-none-match header.

Overrides:

getIfNoneMatchEtag in class BoxRequest<BoxFolder,BoxRequestsFolder.GetFolderInfo>

Returns:

etag set in the if-none-match header, or null if none set.

setLimit

public BoxRequestsFolder.GetFolderInfo setLimit(int limit)

Sets the limit of items that should be returned

Parameters:

limit - limit of items to return

Returns:

the get folder info request

setOffset

public BoxRequestsFolder.GetFolderInfo setOffset(int offset)

Sets the offset of the items that should be returned

Parameters:

offset - offset of items to return

Returns:

the offset of the items to return

sendForCachedResult

public BoxFolder sendForCachedResult()
                              throws BoxException

Description copied from interface: BoxCacheableRequest

Sends the request to fetch results from cache synchronously.

Specified by:

sendForCachedResult in interface BoxCacheableRequest<BoxFolder>

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

Returns:

a task that will fetch the results from the cache

Throws:

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