com.box.androidsdk.content.requests

Class BoxRequestsBookmark.GetBookmarkInfo

java.lang.Object

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

com.box.androidsdk.content.requests.BoxRequestItem<BoxBookmark,BoxRequestsBookmark.GetBookmarkInfo>

com.box.androidsdk.content.requests.BoxRequestsBookmark.GetBookmarkInfo

Enclosing class:

BoxRequestsBookmark

public static class BoxRequestsBookmark.GetBookmarkInfo
extends BoxRequestItem<BoxBookmark,BoxRequestsBookmark.GetBookmarkInfo>

Request for retrieving information on a bookmark

Nested Class Summary

Nested classes/interfaces inherited from class com.box.androidsdk.content.requests.BoxRequest

BoxRequest.BoxRequestHandler, 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

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

Constructor Summary

Constructors

Constructor and Description
BoxRequestsBookmark.GetBookmarkInfo(java.lang.String id, java.lang.String requestUrl, BoxSession session) Creates a bookmark 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.
BoxRequestsBookmark.GetBookmarkInfo	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, 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

BoxRequestsBookmark.GetBookmarkInfo

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

Creates a bookmark information request with the default parameters

Parameters:

id - id of the bookmark to get information on

requestUrl - URL of the bookmark information endpoint

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

Method Detail

setIfNoneMatchEtag

public BoxRequestsBookmark.GetBookmarkInfo setIfNoneMatchEtag(java.lang.String etag)

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

Overrides:

setIfNoneMatchEtag in class BoxRequest<BoxBookmark,BoxRequestsBookmark.GetBookmarkInfo>

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<BoxBookmark,BoxRequestsBookmark.GetBookmarkInfo>

Returns:

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