com.box.androidsdk.content.requests

Class BoxRequestsBookmark.DeleteTrashedBookmark

java.lang.Object

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

com.box.androidsdk.content.requests.BoxRequestsBookmark.DeleteTrashedBookmark

Enclosing class:

BoxRequestsBookmark

public static class BoxRequestsBookmark.DeleteTrashedBookmark
extends BoxRequest<BoxVoid,R>

Request for permanently deleting a trashed bookmark

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

Modifier and Type	Field and Description
protected java.lang.String	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
DeleteTrashedBookmark(java.lang.String id, java.lang.String requestUrl, BoxSession session) Creates a delete trashed bookmark request with the default parameters

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Gets the id of the item to delete.
java.lang.String	getIfMatchEtag() Returns the currently set etag for the if-match header of the request.
R	setIfMatchEtag(java.lang.String etag) Sets the if-match header for the request.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

mId

protected java.lang.String mId

Constructor Detail

DeleteTrashedBookmark

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

Creates a delete trashed bookmark request with the default parameters

Parameters:

id - id of the trashed bookmark to permanently delete

requestUrl - URL of the delete trashed bookmark endpoint

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

Method Detail

getId

public java.lang.String getId()

Gets the id of the item to delete.

Returns:

id of the item to delete.

setIfMatchEtag

public R setIfMatchEtag(java.lang.String etag)

Sets the if-match header for the request. The item will only be deleted if the specified etag matches the most current etag for the item.

Overrides:

setIfMatchEtag in class BoxRequest<BoxVoid,R extends BoxRequest<BoxVoid,R>>

Parameters:

etag - etag to set in the if-match header.

Returns:

the request with the updated if-match header.

getIfMatchEtag

public java.lang.String getIfMatchEtag()

Returns the currently set etag for the if-match header of the request.

Overrides:

getIfMatchEtag in class BoxRequest<BoxVoid,R extends BoxRequest<BoxVoid,R>>

Returns:

etag currently set in the if-match header.