com.box.androidsdk.content.requests

Class BoxRequestsFile.GetFileInfo

java.lang.Object

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

com.box.androidsdk.content.requests.BoxRequestItem<BoxFile,BoxRequestsFile.GetFileInfo>

com.box.androidsdk.content.requests.BoxRequestsFile.GetFileInfo

Enclosing class:

BoxRequestsFile

public static class BoxRequestsFile.GetFileInfo
extends BoxRequestItem<BoxFile,BoxRequestsFile.GetFileInfo>

Request for retrieving information on a file

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

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

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

Constructor Summary

Constructors

Constructor and Description
BoxRequestsFile.GetFileInfo(java.lang.String id, java.lang.String requestUrl, BoxSession session) Creates a file information request with the default parameters

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getIfNoneMatchEtag() Returns the etag currently set in the if-none-match header.
BoxRequestsFile.GetFileInfo	setIfNoneMatchEtag(java.lang.String etag) Sets the if-none-match header for the request.

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

getId, setFields

Methods inherited from class com.box.androidsdk.content.requests.BoxRequest

buildUrl, createHttpRequest, createQuery, getIfMatchEtag, getRequestHandler, getSession, getStringBody, importRequestContentMapsFrom, logDebug, logRequest, parseHashMapEntry, parseJsonObject, send, setBody, setContentType, setHeaders, setIfMatchEtag, setRequestHandler, setTimeOut, toTask

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxRequestsFile.GetFileInfo

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

Creates a file information request with the default parameters

Parameters:

id - id of the file to get information on

requestUrl - URL of the file information endpoint

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

Method Detail

setIfNoneMatchEtag

public BoxRequestsFile.GetFileInfo setIfNoneMatchEtag(java.lang.String etag)

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

Overrides:

setIfNoneMatchEtag in class BoxRequest<BoxFile,BoxRequestsFile.GetFileInfo>

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<BoxFile,BoxRequestsFile.GetFileInfo>

Returns:

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