org.apache.camel.component.box.api

Class BoxCommentsManager

java.lang.Object

org.apache.camel.component.box.api.BoxCommentsManager

public class BoxCommentsManager
extends Object

Provides operations to manage Box comments.

Constructor Summary

Constructors

Constructor and Description
BoxCommentsManager(com.box.sdk.BoxAPIConnection boxConnection) Create comments manager to manage the comments of Box connection's authenticated user.

Method Summary

Modifier and Type	Method and Description
com.box.sdk.BoxFile	addFileComment(String fileId, String message) Add comment to file.
com.box.sdk.BoxComment	changeCommentMessage(String commentId, String message) Change comment message.
void	deleteComment(String commentId) Delete comment.
com.box.sdk.BoxComment.Info	getCommentInfo(String commentId) Get comment information.
List<com.box.sdk.BoxComment.Info>	getFileComments(String fileId) Get a list of any comments on this file.
com.box.sdk.BoxComment	replyToComment(String commentId, String message) Reply to a comment.

Methods inherited from class java.lang.Object

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

Constructor Detail

BoxCommentsManager

public BoxCommentsManager(com.box.sdk.BoxAPIConnection boxConnection)

Create comments manager to manage the comments of Box connection's authenticated user.

Parameters:

boxConnection - - Box connection to authenticated user account.

Method Detail

addFileComment

public com.box.sdk.BoxFile addFileComment(String fileId,
                                          String message)

Add comment to file.

Parameters:

fileId - - the id of file.

message - - the comment's message.

Returns:

The commented file.

getFileComments

public List<com.box.sdk.BoxComment.Info> getFileComments(String fileId)

Get a list of any comments on this file.

Parameters:

fileId - - the id of file.

Returns:

The list of comments on this file.

getCommentInfo

public com.box.sdk.BoxComment.Info getCommentInfo(String commentId)

Get comment information.

Parameters:

commentId - - the id of comment.

Returns:

The comment information.

replyToComment

public com.box.sdk.BoxComment replyToComment(String commentId,
                                             String message)

Reply to a comment.

Parameters:

commentId - - the id of comment to reply to.

message - - the message for the reply.

Returns:

The newly created reply comment.

changeCommentMessage

public com.box.sdk.BoxComment changeCommentMessage(String commentId,
                                                   String message)

Change comment message.

Parameters:

commentId - - the id of comment to change.

message - - the new message for the comment.

Returns:

The comment with changed message.

deleteComment

public void deleteComment(String commentId)

Delete comment.

Parameters:

commentId - - the id of comment to delete.