com.box.androidsdk.content.requests

Class BoxRequestsMetadata.UpdateFileMetadata

java.lang.Object

com.box.androidsdk.content.requests.BoxRequest<BoxMetadata,BoxRequestsMetadata.UpdateFileMetadata>

com.box.androidsdk.content.requests.BoxRequestsMetadata.UpdateFileMetadata

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsMetadata

public static class BoxRequestsMetadata.UpdateFileMetadata
extends BoxRequest<BoxMetadata,BoxRequestsMetadata.UpdateFileMetadata>

Request for udpating metadata on a file

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BoxRequestsMetadata.UpdateFileMetadata.Operations ENUM that defines all possible update operations.

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

JSON_OBJECT, mBodyMap, mContentType, mHeaderMap, mListener, mQueryMap, mRequestMethod, mRequestUrlString, mRequiresSocket, mSession, mTimeout

Constructor Summary

Constructors

Constructor and Description
UpdateFileMetadata(java.lang.String requestUrl, BoxSession session) Creates a update file metadata request with the default parameters

Method Summary

Modifier and Type	Method and Description
BoxRequestsMetadata.UpdateFileMetadata	addUpdateTask(BoxRequestsMetadata.UpdateFileMetadata.Operations operation, java.lang.String key) Defaults new value to an empty string.
BoxRequestsMetadata.UpdateFileMetadata	addUpdateTask(BoxRequestsMetadata.UpdateFileMetadata.Operations operation, java.lang.String key, java.lang.String value) Add new update task to request.
protected BoxRequestsMetadata.UpdateFileMetadata	setUpdateTasks(BoxArray<com.box.androidsdk.content.requests.BoxRequestsMetadata.UpdateFileMetadata.BoxMetadataUpdateTask> updateTasks) Updates the values of the item used in the request.

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

UpdateFileMetadata

public UpdateFileMetadata(java.lang.String requestUrl,
                          BoxSession session)

Creates a update file metadata request with the default parameters

Parameters:

requestUrl - URL of the file metadata endpoint

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

Method Detail

setUpdateTasks

protected BoxRequestsMetadata.UpdateFileMetadata setUpdateTasks(BoxArray<com.box.androidsdk.content.requests.BoxRequestsMetadata.UpdateFileMetadata.BoxMetadataUpdateTask> updateTasks)

Updates the values of the item used in the request.

Parameters:

updateTasks - task list for metadata update.

Returns:

request with the updated values.

addUpdateTask

public BoxRequestsMetadata.UpdateFileMetadata addUpdateTask(BoxRequestsMetadata.UpdateFileMetadata.Operations operation,
                                                            java.lang.String key,
                                                            java.lang.String value)

Add new update task to request.

Parameters:

operation - The operation to apply.

key - The key.

value - The value for the path (key). Can leave blank if performing REMOVE operation.

Returns:

request with the updated values.

addUpdateTask

public BoxRequestsMetadata.UpdateFileMetadata addUpdateTask(BoxRequestsMetadata.UpdateFileMetadata.Operations operation,
                                                            java.lang.String key)

Defaults new value to an empty string.

Parameters:

operation - The operation to apply.

key - The key.

Returns:

request with the updated values.