com.box.androidsdk.content.requests

Class BoxRequestsBookmark.UpdateBookmark

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<BoxBookmark,BoxRequestsBookmark.UpdateBookmark>

com.box.androidsdk.content.requests.BoxRequestsBookmark.UpdateBookmark

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsBookmark

public static class BoxRequestsBookmark.UpdateBookmark
extends BoxRequestItemUpdate<BoxBookmark,BoxRequestsBookmark.UpdateBookmark>

Request for updating information on a bookmark

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
UpdateBookmark(java.lang.String id, java.lang.String requestUrl, BoxSession session) Creates an update file request with the default parameters

Method Summary

Modifier and Type	Method and Description
java.lang.String	getUrl() Returns the URL for the bookmark currently set in the request.
BoxRequestsBookmark.UpdateBookmark	setUrl(java.lang.String url) Sets the new URL for the bookmark in the request.
BoxRequestsBookmark.UpdateSharedBookmark	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

UpdateBookmark

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

Creates an update file request with the default parameters

Parameters:

id - id of the file to update information on

requestUrl - URL of the update file endpoint

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

Method Detail

getUrl

public java.lang.String getUrl()

Returns the URL for the bookmark currently set in the request.

Returns:

URL for the bookmark.

setUrl

public BoxRequestsBookmark.UpdateBookmark setUrl(java.lang.String url)

Sets the new URL for the bookmark in the request.

Parameters:

url - new URL for the bookmark.

Returns:

request with the updated bookmark URL.

updateSharedLink

public BoxRequestsBookmark.UpdateSharedBookmark 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<BoxBookmark,BoxRequestsBookmark.UpdateBookmark>

Returns:

BoxRequestUpdateSharedItem from the BoxRequestItemUpdate.