com.box.androidsdk.content.requests

Class BoxRequestsShare.GetSharedLink

java.lang.Object

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

com.box.androidsdk.content.requests.BoxRequestItem<BoxItem,BoxRequestsShare.GetSharedLink>

com.box.androidsdk.content.requests.BoxRequestsShare.GetSharedLink

All Implemented Interfaces:

BoxCacheableRequest<BoxItem>, java.io.Serializable

Enclosing class:

BoxRequestsShare

public static class BoxRequestsShare.GetSharedLink
extends BoxRequestItem<BoxItem,BoxRequestsShare.GetSharedLink>
implements BoxCacheableRequest<BoxItem>

A request to get an item from a Shared 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, 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
GetSharedLink(java.lang.String requestUrl, BoxSharedLinkSession session) Creates a get item from shared link request with the default parameters

Method Summary

Modifier and Type	Method and Description
static BoxRequest.BoxRequestHandler<BoxRequestsShare.GetSharedLink>	createRequestHandler(BoxRequestsShare.GetSharedLink request)
java.lang.String	getIfNoneMatchEtag()
BoxItem	sendForCachedResult() Sends the request to fetch results from cache synchronously.
BoxRequestsShare.GetSharedLink	setIfNoneMatchEtag(java.lang.String etag)
BoxFutureTask<BoxItem>	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

GetSharedLink

public GetSharedLink(java.lang.String requestUrl,
                     BoxSharedLinkSession session)

Creates a get item from shared link request with the default parameters

Parameters:

requestUrl - URL of the shared items endpoint

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

Method Detail

setIfNoneMatchEtag

public BoxRequestsShare.GetSharedLink setIfNoneMatchEtag(java.lang.String etag)

Overrides:

setIfNoneMatchEtag in class BoxRequest<BoxItem,BoxRequestsShare.GetSharedLink>

getIfNoneMatchEtag

public java.lang.String getIfNoneMatchEtag()

Overrides:

getIfNoneMatchEtag in class BoxRequest<BoxItem,BoxRequestsShare.GetSharedLink>

sendForCachedResult

public BoxItem sendForCachedResult()
                            throws BoxException

Description copied from interface: BoxCacheableRequest

Sends the request to fetch results from cache synchronously.

Specified by:

sendForCachedResult in interface BoxCacheableRequest<BoxItem>

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

Returns:

a task that will fetch the results from the cache

Throws:

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

createRequestHandler

public static BoxRequest.BoxRequestHandler<BoxRequestsShare.GetSharedLink> createRequestHandler(BoxRequestsShare.GetSharedLink request)