com.box.androidsdk.content.requests

Class BoxRequestUpdateSharedItem<E extends BoxItem,R extends BoxRequest<E,R>>

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

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

Type Parameters:

E - type of BoxItem to be returned in the response.

R - type of BoxRequest being created.

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BoxRequestsBookmark.UpdateSharedBookmark, BoxRequestsFile.UpdatedSharedFile, BoxRequestsFolder.UpdateSharedFolder

public abstract class BoxRequestUpdateSharedItem<E extends BoxItem,R extends BoxRequest<E,R>>
extends BoxRequestItemUpdate<E,R>

Class representing a request to update a shared item.

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

Modifier	Constructor and Description
protected	BoxRequestUpdateSharedItem(BoxRequestItemUpdate r)
	BoxRequestUpdateSharedItem(java.lang.Class<E> clazz, java.lang.String id, java.lang.String requestUrl, BoxSession session)

Method Summary

Modifier and Type	Method and Description
BoxSharedLink.Access	getAccess() Gets the shared link access currently set for the item in the request.
protected java.lang.Boolean	getCanDownload() Returns the value for whether the shared link allows downloads currently set in the request.
java.lang.String	getPassword() Returns the shared link password currently set in the request.
java.util.Date	getUnsharedAt() Returns the date the link will be disabled at currently set in the request.
R	setAccess(BoxSharedLink.Access access) Sets the shared link access for the item in the request.
protected R	setCanDownload(boolean canDownload) Sets whether the shared link allows downloads in the request.
R	setPassword(java.lang.String password) Sets the shared link password in the request.
R	setRemoveUnsharedAtDate() Removes an unshared at date that is set on this item.
R	setUnsharedAt(java.util.Date unsharedAt) Sets the date that this shared link will be deactivated.
BoxRequestUpdateSharedItem	updateSharedLink() Converts the BoxRequestItemUpdate into a BoxRequestUpdateSharedItem.

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

getDescription, getIfMatchEtag, getName, getParentId, getSharedLink, getTags, parseHashMapEntry, 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

BoxRequestUpdateSharedItem

public BoxRequestUpdateSharedItem(java.lang.Class<E> clazz,
                                  java.lang.String id,
                                  java.lang.String requestUrl,
                                  BoxSession session)

BoxRequestUpdateSharedItem

protected BoxRequestUpdateSharedItem(BoxRequestItemUpdate r)

Method Detail

getAccess

public BoxSharedLink.Access getAccess()

Gets the shared link access currently set for the item in the request.

Returns:

shared link access for the item, or null if not set.

setAccess

public R setAccess(BoxSharedLink.Access access)

Sets the shared link access for the item in the request.

Parameters:

access - new shared link access for the item.

Returns:

request with the updated shared link access.

getUnsharedAt

public java.util.Date getUnsharedAt()

Returns the date the link will be disabled at currently set in the request.

Returns:

date the shared link will be disabled at, or null if not set.

setUnsharedAt

public R setUnsharedAt(java.util.Date unsharedAt)
                throws java.text.ParseException

Sets the date that this shared link will be deactivated. If this is set to null it will remove the unshared at date that is set on this item. Note: the date will be rounded to the day as the API does not support hours, minutes, or seconds

Parameters:

unsharedAt - the date that this shared link will be deactivated.

Returns:

the updated request

Throws:

java.text.ParseException - thrown if date provided cannot be properly parsed.

setRemoveUnsharedAtDate

public R setRemoveUnsharedAtDate()
                          throws java.text.ParseException

Removes an unshared at date that is set on this item.

Returns:

the updated request

Throws:

java.text.ParseException - thrown if date provided cannot be properly parsed.

getPassword

public java.lang.String getPassword()

Returns the shared link password currently set in the request.

Returns:

the password for the item's shared link, or null if not set.

setPassword

public R setPassword(java.lang.String password)

Sets the shared link password in the request.

Parameters:

password - new password for the shared link, or null to remove the password.

Returns:

request with the updated shared link password.

getCanDownload

protected java.lang.Boolean getCanDownload()

Returns the value for whether the shared link allows downloads currently set in the request.

Returns:

Boolean for whether the shared link allows downloads, or null if not set.

setCanDownload

protected R setCanDownload(boolean canDownload)

Sets whether the shared link allows downloads in the request.

Parameters:

canDownload - new value for whether the shared link allows downloads.

Returns:

request with the updated value for whether the shared link allows downloads.

updateSharedLink

public BoxRequestUpdateSharedItem 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<E extends BoxItem,R extends BoxRequest<E,R>>

Returns:

an instance of this BoxRequestUpdateSharedItem that can be used to update current shared link.