com.box.androidsdk.content.requests

Class BoxRequestsComment.UpdateComment

java.lang.Object

com.box.androidsdk.content.requests.BoxRequest<BoxComment,BoxRequestsComment.UpdateComment>

com.box.androidsdk.content.requests.BoxRequestsComment.UpdateComment

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsComment

public static class BoxRequestsComment.UpdateComment
extends BoxRequest<BoxComment,BoxRequestsComment.UpdateComment>

Request for updating the message on a comment

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

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

Constructor Summary

Constructors

Constructor and Description
UpdateComment(java.lang.String id, java.lang.String message, java.lang.String requestUrl, BoxSession session) Creates an update comment request with the default parameters

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Gets the id of the comment to be updated in the request
java.lang.String	getMessage() Gets the message currently set as the new message for the comment in the update request
protected void	onSendCompleted(BoxResponse<BoxComment> response) Post action that will be performed after a successful send occurs.
BoxRequestsComment.UpdateComment	setMessage(java.lang.String message)

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

UpdateComment

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

Creates an update comment request with the default parameters

Parameters:

id - id of the comment to update information on

message - the new message for the comment

requestUrl - URL of the update comment endpoint

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

Method Detail

getId

public java.lang.String getId()

Gets the id of the comment to be updated in the request

Returns:

id of the comment that will be updated

getMessage

public java.lang.String getMessage()

Gets the message currently set as the new message for the comment in the update request

Returns:

message to update the comment to

setMessage

public BoxRequestsComment.UpdateComment setMessage(java.lang.String message)

onSendCompleted

protected void onSendCompleted(BoxResponse<BoxComment> response)
                        throws BoxException

Description copied from class: BoxRequest

Post action that will be performed after a successful send occurs. Example useage would include updating the cache after a request is made

Overrides:

onSendCompleted in class BoxRequest<BoxComment,BoxRequestsComment.UpdateComment>

Parameters:

response - response of the BoxRequest

Throws:

BoxException - thrown if there was a problem with handling the request.