com.box.androidsdk.content.requests

Class BoxRequestsFile.RestoreTrashedFile

java.lang.Object

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

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

com.box.androidsdk.content.requests.BoxRequestsFile.RestoreTrashedFile

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsFile

public static class BoxRequestsFile.RestoreTrashedFile
extends BoxRequestItem<E,R>

Request for restoring a trashed file

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

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
RestoreTrashedFile(java.lang.String id, java.lang.String requestUrl, BoxSession session) Creates a restore trashed file request with the default parameters

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Returns the name currently set for the restored item, or null if not set.
java.lang.String	getParentId() Returns the parent id currently set for the restored item, or null if not set.
protected void	parseHashMapEntry(com.eclipsesource.json.JsonObject jsonBody, java.util.Map.Entry<java.lang.String,java.lang.Object> entry)
R	setName(java.lang.String name) Sets the new name for the restored item.
R	setParentId(java.lang.String parentId) Sets the id of the parent folder for the restored item.

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

getId, onSendCompleted, setFields

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

buildUrl, createHeaderMap, createHttpRequest, createQuery, equals, getIfMatchEtag, getIfNoneMatchEtag, getRequestHandler, getSession, getSocket, getStringBody, handleSendForCachedResult, handleToTaskForCachedResult, handleUpdateCache, hashCode, importRequestContentMapsFrom, logDebug, logRequest, onSend, parseJsonObject, send, sendRequest, setBody, setContentType, setHeaders, setIfMatchEtag, setIfNoneMatchEtag, setRequestHandler, setTimeOut, toTask

Methods inherited from class java.lang.Object

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

Constructor Detail

RestoreTrashedFile

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

Creates a restore trashed file request with the default parameters

Parameters:

id - id of the trashed file to restore

requestUrl - URL of the restore trashed file endpoint

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

Method Detail

getName

public java.lang.String getName()

Returns the name currently set for the restored item, or null if not set.

Returns:

new name for the restored item.

setName

public R setName(java.lang.String name)

Sets the new name for the restored item. If null, the restored item will keep its original name.

Parameters:

name - name for the restored item.

Returns:

request with the updated name for the restored item.

getParentId

public java.lang.String getParentId()

Returns the parent id currently set for the restored item, or null if not set.

Returns:

parent id for the restored item.

setParentId

public R setParentId(java.lang.String parentId)

Sets the id of the parent folder for the restored item. If null, the restored item will be restored to its original parent folder.

Parameters:

parentId - id of the parent folder for the restored item.

Returns:

request with the updated parent folder id.

parseHashMapEntry

protected void parseHashMapEntry(com.eclipsesource.json.JsonObject jsonBody,
                                 java.util.Map.Entry<java.lang.String,java.lang.Object> entry)

Overrides:

parseHashMapEntry in class BoxRequest<E extends BoxItem,R extends BoxRequest<E,R>>