com.box.androidsdk.content.requests

Class BoxRequestsFile.CopyFile

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

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsFile

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

Request for copying a 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
CopyFile(java.lang.String id, java.lang.String parentId, java.lang.String requestUrl, BoxSession session) Creates a copy 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 item copy.
java.lang.String	getParentId() Returns the parent id currently set for the item copy.
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 name used in the request for the item copy.
R	setParentId(java.lang.String parentId) Sets the parent id used in the request for the item copy.

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

CopyFile

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

Creates a copy file request with the default parameters

Parameters:

id - id of the file to copy

parentId - id of the new parent folder

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

Returns:

name for the item copy, or null if not set

setName

public R setName(java.lang.String name)

Sets the name used in the request for the item copy.

Parameters:

name - name for the copy of the item.

Returns:

request with the updated name.

getParentId

public java.lang.String getParentId()

Returns the parent id currently set for the item copy.

Returns:

id of the parent folder for the item copy.

setParentId

public R setParentId(java.lang.String parentId)

Sets the parent id used in the request for the item copy.

Parameters:

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

Returns:

request with the updated parent 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>>