com.box.androidsdk.content

Class BoxApiComment

java.lang.Object

com.box.androidsdk.content.BoxApi

com.box.androidsdk.content.BoxApiComment

public class BoxApiComment
extends BoxApi

Represents the API of the comment endpoint on Box. This class can be used to generate request objects for each of the APIs exposed endpoints

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMMENTS_ENDPOINT

Fields inherited from class com.box.androidsdk.content.BoxApi

mBaseUploadUri, mBaseUri, mSession

Constructor Summary

Constructors

Constructor and Description
BoxApiComment(BoxSession session) Constructs a BoxApiComment with the provided BoxSession

Method Summary

Modifier and Type	Method and Description
BoxRequestsComment.AddReplyComment	getAddCommentReplyRequest(java.lang.String commentId, java.lang.String message) Gets a request that adds a reply comment to a comment
protected java.lang.String	getCommentInfoUrl(java.lang.String id)
protected java.lang.String	getCommentsUrl()
BoxRequestsComment.DeleteComment	getDeleteRequest(java.lang.String id) Gets a request that deletes a comment
BoxRequestsComment.GetCommentInfo	getInfoRequest(java.lang.String id) Gets a request that retrieves information on a comment
BoxRequestsComment.UpdateComment	getUpdateRequest(java.lang.String id, java.lang.String newMessage) Gets a request that updates a comment's information

Methods inherited from class com.box.androidsdk.content.BoxApi

getBaseUploadUri, getBaseUri

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMMENTS_ENDPOINT

public static final java.lang.String COMMENTS_ENDPOINT

See Also:

Constant Field Values

Constructor Detail

BoxApiComment

public BoxApiComment(BoxSession session)

Constructs a BoxApiComment with the provided BoxSession

Parameters:

session - authenticated session to use with the BoxApiComment

Method Detail

getCommentsUrl

protected java.lang.String getCommentsUrl()

getCommentInfoUrl

protected java.lang.String getCommentInfoUrl(java.lang.String id)

getInfoRequest

public BoxRequestsComment.GetCommentInfo getInfoRequest(java.lang.String id)

Gets a request that retrieves information on a comment

Parameters:

id - id of comment to retrieve info on

Returns:

request to get a comment's information

getAddCommentReplyRequest

public BoxRequestsComment.AddReplyComment getAddCommentReplyRequest(java.lang.String commentId,
                                                                    java.lang.String message)

Gets a request that adds a reply comment to a comment

Parameters:

commentId - id of the comment to reply to

message - message for the comment that will be added

Returns:

request to add a reply comment to a comment

getUpdateRequest

public BoxRequestsComment.UpdateComment getUpdateRequest(java.lang.String id,
                                                         java.lang.String newMessage)

Gets a request that updates a comment's information

Parameters:

id - id of comment to update information on

newMessage - new message for the comment

Returns:

request to update a comment's information

getDeleteRequest

public BoxRequestsComment.DeleteComment getDeleteRequest(java.lang.String id)

Gets a request that deletes a comment

Parameters:

id - id of comment to delete

Returns:

request to delete a comment