com.box.androidsdk.content.requests

Class BoxRequestItemDelete<R extends BoxRequest<BoxVoid,R>>

java.lang.Object

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

com.box.androidsdk.content.requests.BoxRequestItemDelete<R>

Type Parameters:

R - type of BoxRequest that is being created.

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BoxRequestsBookmark.DeleteBookmark, BoxRequestsBookmark.DeleteTrashedBookmark, BoxRequestsFile.DeleteFile, BoxRequestsFile.DeleteTrashedFile, BoxRequestsFolder.DeleteFolder, BoxRequestsFolder.DeleteTrashedFolder

public abstract class BoxRequestItemDelete<R extends BoxRequest<BoxVoid,R>>
extends BoxRequest<BoxVoid,R>

Abstract class that represents a request to delete a BoxItem.

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

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, mRequiresSocket, mSession, mTimeout

Constructor Summary

Constructors

Constructor and Description
BoxRequestItemDelete(java.lang.String id, java.lang.String requestUrl, BoxSession session) Constructs an item delete 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, createHeaderMap, createHttpRequest, createQuery, equals, getIfNoneMatchEtag, getRequestHandler, getSession, getSocket, getStringBody, handleSendForCachedResult, handleToTaskForCachedResult, handleUpdateCache, hashCode, importRequestContentMapsFrom, logDebug, logRequest, onSend, onSendCompleted, parseHashMapEntry, parseJsonObject, send, sendRequest, setBody, setContentType, setHeaders, setIfNoneMatchEtag, setRequestHandler, setTimeOut, toTask

Methods inherited from class java.lang.Object

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

Field Detail

mId

protected java.lang.String mId

Constructor Detail

BoxRequestItemDelete

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

Constructs an item delete request with the default parameters.

Parameters:

id - id of the Box item to delete.

requestUrl - URL of the delete 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.