com.box.androidsdk.content.requests

Class BoxRequestsFile.GetEmbedLinkFileInfo

java.lang.Object

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

com.box.androidsdk.content.requests.BoxRequestItem<BoxExpiringEmbedLinkFile,BoxRequestsFile.GetEmbedLinkFileInfo>

com.box.androidsdk.content.requests.BoxRequestsFile.GetEmbedLinkFileInfo

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsFile

public static class BoxRequestsFile.GetEmbedLinkFileInfo
extends BoxRequestItem<BoxExpiringEmbedLinkFile,BoxRequestsFile.GetEmbedLinkFileInfo>

Request for retrieving information on a file with an expiring embed link

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
GetEmbedLinkFileInfo(java.lang.String id, java.lang.String requestUrl, BoxSession session) Creates a file 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.
BoxRequestsFile.GetEmbedLinkFileInfo	setFields(java.lang.String... fields) Sets the fields to return in the response.
BoxRequestsFile.GetEmbedLinkFileInfo	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, onSendCompleted

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

buildUrl, createHeaderMap, 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

GetEmbedLinkFileInfo

public GetEmbedLinkFileInfo(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

setFields

public BoxRequestsFile.GetEmbedLinkFileInfo setFields(java.lang.String... fields)

Description copied from class: BoxRequestItem

Sets the fields to return in the response.

Overrides:

setFields in class BoxRequestItem<BoxExpiringEmbedLinkFile,BoxRequestsFile.GetEmbedLinkFileInfo>

Parameters:

fields - fields to return in the response.

Returns:

request with the updated fields.

setIfNoneMatchEtag

public BoxRequestsFile.GetEmbedLinkFileInfo 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<BoxExpiringEmbedLinkFile,BoxRequestsFile.GetEmbedLinkFileInfo>

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<BoxExpiringEmbedLinkFile,BoxRequestsFile.GetEmbedLinkFileInfo>

Returns:

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