com.box.androidsdk.content.requests

Class BoxRequestsMetadata.GetItemMetadata

java.lang.Object

com.box.androidsdk.content.requests.BoxRequest<BoxMetadata,BoxRequestsMetadata.GetItemMetadata>

com.box.androidsdk.content.requests.BoxRequestsMetadata.GetItemMetadata

All Implemented Interfaces:

BoxCacheableRequest<BoxMetadata>, java.io.Serializable

Direct Known Subclasses:

BoxRequestsMetadata.GetFileMetadata

Enclosing class:

BoxRequestsMetadata

public static class BoxRequestsMetadata.GetItemMetadata
extends BoxRequest<BoxMetadata,BoxRequestsMetadata.GetItemMetadata>
implements BoxCacheableRequest<BoxMetadata>

Request for getting metadata 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, 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
GetItemMetadata(java.lang.String requestUrl, BoxSession session) Creates a get file metadata request with the default parameters

Method Summary

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

GetItemMetadata

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

Creates a get file metadata request with the default parameters

Parameters:

requestUrl - URL of the file metadata endpoint

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

Method Detail

sendForCachedResult

public BoxMetadata sendForCachedResult()
                                throws BoxException

Description copied from interface: BoxCacheableRequest

Sends the request to fetch results from cache synchronously.

Specified by:

sendForCachedResult in interface BoxCacheableRequest<BoxMetadata>

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

Returns:

a task that will fetch the results from the cache

Throws:

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