com.box.androidsdk.content.requests

Class BoxRequestsBookmark.CreateBookmark

java.lang.Object

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

com.box.androidsdk.content.requests.BoxRequestItem<BoxBookmark,BoxRequestsBookmark.CreateBookmark>

com.box.androidsdk.content.requests.BoxRequestsBookmark.CreateBookmark

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsBookmark

public static class BoxRequestsBookmark.CreateBookmark
extends BoxRequestItem<BoxBookmark,BoxRequestsBookmark.CreateBookmark>

Request for creating a new 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
CreateBookmark(java.lang.String parentId, java.lang.String url, java.lang.String requestUrl, BoxSession session) Creates a create bookmark request with the default parameters

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDescription() Returns the description of the new bookmark currently set in the request.
java.lang.String	getName() Returns the name of the new bookmark currently set in the request.
java.lang.String	getParentId() Returns the parent id for the new bookmark currently set in the request.
java.lang.String	getUrl() Returns the URL currently set for the create bookmark request.
BoxRequestsBookmark.CreateBookmark	setDescription(java.lang.String description) Sets the description of the bookmark to be created in the request.
BoxRequestsBookmark.CreateBookmark	setName(java.lang.String name) Sets the name of the bookmark to be created in the request.
BoxRequestsBookmark.CreateBookmark	setParentId(java.lang.String id) Sets the parent id to use in the create bookmark request.
BoxRequestsBookmark.CreateBookmark	setUrl(java.lang.String url) Sets the URL of the bookmark to be created in the request.

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

CreateBookmark

public CreateBookmark(java.lang.String parentId,
                      java.lang.String url,
                      java.lang.String requestUrl,
                      BoxSession session)

Creates a create bookmark request with the default parameters

Parameters:

parentId - id of the parent folder for the new bookmark

url - URL of the new bookmark

requestUrl - URL of the create bookmark endpoint

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

Method Detail

getParentId

public java.lang.String getParentId()

Returns the parent id for the new bookmark currently set in the request.

Returns:

id of the parent for the new bookmark

setParentId

public BoxRequestsBookmark.CreateBookmark setParentId(java.lang.String id)

Sets the parent id to use in the create bookmark request.

Parameters:

id - id of the parent folder for the new bookmark

Returns:

the request with the updated parent id

getUrl

public java.lang.String getUrl()

Returns the URL currently set for the create bookmark request.

Returns:

the URL for the new bookmark

setUrl

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

Sets the URL of the bookmark to be created in the request.

Parameters:

url - URL of the new bookmark

Returns:

the request with the updated URL

getName

public java.lang.String getName()

Returns the name of the new bookmark currently set in the request. Will return null if not set.

Returns:

name of the bookmark that will be created.

setName

public BoxRequestsBookmark.CreateBookmark setName(java.lang.String name)

Sets the name of the bookmark to be created in the request.

Parameters:

name - name of the bookmark to be created

Returns:

the request with the updated name

getDescription

public java.lang.String getDescription()

Returns the description of the new bookmark currently set in the request. Will return null if not set.

Returns:

description of the bookmark that will be created

setDescription

public BoxRequestsBookmark.CreateBookmark setDescription(java.lang.String description)

Sets the description of the bookmark to be created in the request.

Parameters:

description - new description for the bookmark to be created

Returns:

the request with the updated description