com.box.androidsdk.content.requests

Class BoxRequestsFolder.DeleteFolder

java.lang.Object

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

com.box.androidsdk.content.requests.BoxRequestItemDelete<BoxRequestsFolder.DeleteFolder>

com.box.androidsdk.content.requests.BoxRequestsFolder.DeleteFolder

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsFolder

public static class BoxRequestsFolder.DeleteFolder
extends BoxRequestItemDelete<BoxRequestsFolder.DeleteFolder>

Request for deleting a folder

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.BoxRequestItemDelete

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
DeleteFolder(java.lang.String id, java.lang.String requestUrl, BoxSession session) Creates a delete folder request with the default parameters

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getRecursive() Gets whether the folder delete should be recursive and delete all child folders
protected void	onSendCompleted(BoxResponse<BoxVoid> response) Post action that will be performed after a successful send occurs.
BoxRequestsFolder.DeleteFolder	setRecursive(boolean recursive) Sets whether the folder delete should be recursive and delete all child folders

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

getId, getIfMatchEtag, setIfMatchEtag

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

Constructor Detail

DeleteFolder

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

Creates a delete folder request with the default parameters

Parameters:

id - id of the folder to delete

requestUrl - URL of the delete folder endpoint

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

Method Detail

setRecursive

public BoxRequestsFolder.DeleteFolder setRecursive(boolean recursive)

Sets whether the folder delete should be recursive and delete all child folders

Parameters:

recursive - whether the delete should be recursive

Returns:

the delete folder request

getRecursive

public java.lang.Boolean getRecursive()

Gets whether the folder delete should be recursive and delete all child folders

Returns:

whether the delete should be recursive

onSendCompleted

protected void onSendCompleted(BoxResponse<BoxVoid> response)
                        throws BoxException

Description copied from class: BoxRequest

Post action that will be performed after a successful send occurs. Example useage would include updating the cache after a request is made

Overrides:

onSendCompleted in class BoxRequest<BoxVoid,BoxRequestsFolder.DeleteFolder>

Parameters:

response - response of the BoxRequest

Throws:

BoxException - thrown if there was a problem with handling the request.