com.box.androidsdk.content.requests

Class BoxRequestsFolder.UpdateFolder

java.lang.Object

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

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

com.box.androidsdk.content.requests.BoxRequestItemUpdate<BoxFolder,BoxRequestsFolder.UpdateFolder>

com.box.androidsdk.content.requests.BoxRequestsFolder.UpdateFolder

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsFolder

public static class BoxRequestsFolder.UpdateFolder
extends BoxRequestItemUpdate<BoxFolder,BoxRequestsFolder.UpdateFolder>

Request for updating information of 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.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
UpdateFolder(java.lang.String id, java.lang.String requestUrl, BoxSession session) Creates an update folder request with the default parameters

Method Summary

Modifier and Type	Method and Description
java.lang.String	getOwnedById() Gets the id of the user that will own the folder after update
BoxFolder.SyncState	getSyncState() Gets the sync state that the folder will be updated with
BoxUploadEmail.Access	getUploadEmailAccess() Gets the upload email address that the folder will be updated with
protected void	parseHashMapEntry(com.eclipsesource.json.JsonObject jsonBody, java.util.Map.Entry<java.lang.String,java.lang.Object> entry)
BoxRequestsFolder.UpdateFolder	setFolderUploadEmailAccess(BoxUploadEmail.Access access) Sets the upload email address that the folder will be updated to
BoxRequestsFolder.UpdateFolder	setOwnedById(java.lang.String userId) Sets the id of the user that will own the folder after update
BoxRequestsFolder.UpdateFolder	setSyncState(BoxFolder.SyncState syncState) Sets the sync state that the folder will be updated to
BoxRequestsFolder.UpdateSharedFolder	updateSharedLink() Converts the BoxRequestItemUpdate into a BoxRequestUpdateSharedItem.

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

getDescription, getIfMatchEtag, getName, getParentId, getSharedLink, getTags, setDescription, setIfMatchEtag, setName, setParentId, setSharedLink, setTags

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, getIfNoneMatchEtag, getRequestHandler, getSession, getSocket, getStringBody, handleSendForCachedResult, handleToTaskForCachedResult, handleUpdateCache, hashCode, importRequestContentMapsFrom, logDebug, logRequest, onSend, 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

UpdateFolder

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

Creates an update folder request with the default parameters

Parameters:

id - id of the folder to update information on

requestUrl - URL of the update folder endpoint

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

Method Detail

updateSharedLink

public BoxRequestsFolder.UpdateSharedFolder updateSharedLink()

Description copied from class: BoxRequestItemUpdate

Converts the BoxRequestItemUpdate into a BoxRequestUpdateSharedItem. Using the request you can update shared link of the item.

Specified by:

updateSharedLink in class BoxRequestItemUpdate<BoxFolder,BoxRequestsFolder.UpdateFolder>

Returns:

BoxRequestUpdateSharedItem from the BoxRequestItemUpdate.

getSyncState

public BoxFolder.SyncState getSyncState()

Gets the sync state that the folder will be updated with

Returns:

updated sync state value

setSyncState

public BoxRequestsFolder.UpdateFolder setSyncState(BoxFolder.SyncState syncState)

Sets the sync state that the folder will be updated to

Parameters:

syncState - sync state that the folder will be set to

Returns:

the update folder request

getUploadEmailAccess

public BoxUploadEmail.Access getUploadEmailAccess()

Gets the upload email address that the folder will be updated with

Returns:

updated upload email address value

setFolderUploadEmailAccess

public BoxRequestsFolder.UpdateFolder setFolderUploadEmailAccess(BoxUploadEmail.Access access)

Sets the upload email address that the folder will be updated to

Parameters:

access - folder upload email access that will be set to

Returns:

the update request

getOwnedById

public java.lang.String getOwnedById()

Gets the id of the user that will own the folder after update

Returns:

id of user to change owners to

setOwnedById

public BoxRequestsFolder.UpdateFolder setOwnedById(java.lang.String userId)

Sets the id of the user that will own the folder after update

Parameters:

userId - id of the user that will own the

Returns:

the update request

parseHashMapEntry

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

Overrides:

parseHashMapEntry in class BoxRequestItemUpdate<BoxFolder,BoxRequestsFolder.UpdateFolder>