com.box.sdk

Class BoxComment.Info

Object

BoxJSONObject

BoxResource.Info

BoxComment.Info

Enclosing class:

BoxComment

public class BoxComment.Info
extends BoxResource.Info

Contains information about a BoxComment.

Constructor Summary

Constructors

Constructor and Description
Info() Constructs an empty Info object.
Info(String json) Constructs an Info object by parsing information from a JSON string.

Method Summary

Modifier and Type	Method and Description
Date	getCreatedAt() Gets the time the comment was created.
BoxUser.Info	getCreatedBy() Gets info about the user who created the comment.
boolean	getIsReplyComment() Gets whether or not the comment is a reply to another comment.
BoxResource.Info	getItem() Gets info about the item this comment is attached to.
String	getMessage() Gets the comment's message.
Date	getModifiedAt() Gets the time the comment was last modified.
BoxUser.Info	getModifiedBy() Gets info about the user who last modified the comment.
BoxComment	getResource() Gets the resource associated with this Info.
protected void	parseJSONMember(JsonObject.Member member) Invoked with a JSON member whenever this object is updated or created from a JSON object.
void	setMessage(String message) Sets the comment's message.

Methods inherited from class BoxResource.Info

getID

Methods inherited from class BoxJSONObject

clearPendingChanges, getJson, getPendingChanges, getPendingChangesAsJsonObject

Methods inherited from class Object

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

Constructor Detail

Info

public Info()

Constructs an empty Info object.

Info

public Info(String json)

Constructs an Info object by parsing information from a JSON string.

Parameters:

json - the JSON string to parse.

Method Detail

getIsReplyComment

public boolean getIsReplyComment()

Gets whether or not the comment is a reply to another comment.

Returns:

true if this comment is a reply to another comment; otherwise false.

getMessage

public String getMessage()

Gets the comment's message.

Returns:

the comment's message.

setMessage

public void setMessage(String message)

Sets the comment's message. The message can contain @mentions by using the string @[userid:username] anywhere within the message, where userid and username are the ID and username of the person being mentioned.

Parameters:

message - the comment's new message.

getCreatedBy

public BoxUser.Info getCreatedBy()

Gets info about the user who created the comment.

Returns:

info about the user who created the comment.

getCreatedAt

public Date getCreatedAt()

Gets the time the comment was created.

Returns:

the time the comment was created.

getItem

public BoxResource.Info getItem()

Gets info about the item this comment is attached to. If the comment is a reply, then the item will be another BoxComment. Otherwise, the item will be a BoxFile.

Returns:

the item this comment is attached to.

getModifiedBy

public BoxUser.Info getModifiedBy()

Gets info about the user who last modified the comment.

Returns:

info about the user who last modified the comment.

getModifiedAt

public Date getModifiedAt()

Gets the time the comment was last modified.

Returns:

the time the comment was last modified.

getResource

public BoxComment getResource()

Description copied from class: BoxResource.Info

Gets the resource associated with this Info.

Specified by:

getResource in class BoxResource.Info

Returns:

the associated resource.

parseJSONMember

protected void parseJSONMember(JsonObject.Member member)

Description copied from class: BoxJSONObject

Invoked with a JSON member whenever this object is updated or created from a JSON object.

Subclasses should override this method in order to parse any JSON members it knows about. This method is a no-op by default.

Parameters:

member - the JSON member to be parsed.