com.box.sdk

Class BoxComment

Object

BoxResource

BoxComment

public class BoxComment
extends BoxResource

Represents a comment on a file. Comments can be added directly to a file or they can be created as replies to other comments.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxComment.Info Contains information about a BoxComment.

Constructor Summary

Constructors

Constructor and Description
BoxComment(BoxAPIConnection api, String id) Constructs a BoxComment for a comment with a given ID.

Method Summary

Methods

Modifier and Type	Method and Description
BoxComment.Info	changeMessage(String newMessage) Changes the message of this comment.
void	delete() Deletes this comment.
BoxComment.Info	getInfo() Gets information about this comment.
BoxComment.Info	reply(String message) Replies to this comment with another message.

Methods inherited from class BoxResource

equals, getAPI, getID, hashCode

Methods inherited from class Object

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

Constructor Detail

BoxComment

public BoxComment(BoxAPIConnection api,
          String id)

Constructs a BoxComment for a comment with a given ID.

Parameters:

api - the API connection to be used with the comment.

id - the ID of the comment.

Method Detail

getInfo

public BoxComment.Info getInfo()

Gets information about this comment.

Returns:

info about this comment.

changeMessage

public BoxComment.Info changeMessage(String newMessage)

Changes the message of this comment.

Parameters:

newMessage - the new message for this comment.

Returns:

updated info about this comment.

reply

public BoxComment.Info reply(String message)

Replies to this comment with another message.

Parameters:

message - the message for the reply.

Returns:

info about the newly created reply comment.

delete

public void delete()

Deletes this comment.