com.box.androidsdk.content.requests

Class BoxRequestsFile.AddTaggedCommentToFile

java.lang.Object

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

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

com.box.androidsdk.content.requests.BoxRequestsFile.AddTaggedCommentToFile

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

BoxRequestsFile

public static class BoxRequestsFile.AddTaggedCommentToFile
extends BoxRequestItem<E,R>

Request for adding a comment with tags to mention users. The server will notify mentioned users of the comment. Tagged users must be collaborators of the parent folder. Format for adding a tag @[userid:username], E.g. "Hello @[12345:Jane Doe]" will create a comment 'Hello Jane Doe', and notify Jane that she has been mentioned.

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
AddTaggedCommentToFile(java.lang.String fileId, java.lang.String taggedMessage, java.lang.String requestUrl, BoxSession session) Creates a file request to add a tagged comment

Method Summary

Modifier and Type	Method and Description
java.lang.String	getItemId() Returns the id of the item currently set in the request to add a comment to.
java.lang.String	getItemType() Returns the type of item used in the request to add a comment to.
java.lang.String	getMessage() Returns the message that is currently set in the request for the new comment.
protected R	setItemId(java.lang.String id) Sets the id of the item used in the request to add a comment to.
protected R	setItemType(java.lang.String type) Sets the type of item used in the request to add a comment to.
R	setMessage(java.lang.String message) Sets the message used in the request to create a new comment.
R	setTaggedMessage(java.lang.String taggedMessage)

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

AddTaggedCommentToFile

public AddTaggedCommentToFile(java.lang.String fileId,
                              java.lang.String taggedMessage,
                              java.lang.String requestUrl,
                              BoxSession session)

Creates a file request to add a tagged comment

Parameters:

fileId - id of the file to add a comment to

taggedMessage - message of the new comment

requestUrl - URL of the add comment endpoint

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

Method Detail

getMessage

public java.lang.String getMessage()

Returns the message that is currently set in the request for the new comment.

Returns:

message for the new comment.

setMessage

public R setMessage(java.lang.String message)

Sets the message used in the request to create a new comment.

Parameters:

message - message for the new comment.

Returns:

request with the updated message.

setTaggedMessage

public R setTaggedMessage(java.lang.String taggedMessage)

getItemId

public java.lang.String getItemId()

Returns the id of the item currently set in the request to add a comment to.

Returns:

id of the item to add a comment to.

setItemId

protected R setItemId(java.lang.String id)

Sets the id of the item used in the request to add a comment to.

Parameters:

id - id of the item to add a comment to.

Returns:

request with the updated item id.

getItemType

public java.lang.String getItemType()

Returns the type of item used in the request to add a comment to.

Returns:

type of item to add a comment to.

setItemType

protected R setItemType(java.lang.String type)

Sets the type of item used in the request to add a comment to.

Parameters:

type - type of item used in the request. Must be "file", "comment", or "web_link".

Returns:

request with the updated item type.