com.box.androidsdk.content.models

Class BoxComment

java.lang.Object

com.box.androidsdk.content.models.BoxObject

com.box.androidsdk.content.models.BoxJsonObject

com.box.androidsdk.content.models.BoxEntity

com.box.androidsdk.content.models.BoxComment

All Implemented Interfaces:

java.io.Serializable

public class BoxComment
extends BoxEntity

Class that represents a comment on Box.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String[]	ALL_FIELDS
static java.lang.String	FIELD_CREATED_AT
static java.lang.String	FIELD_CREATED_BY
static java.lang.String	FIELD_IS_REPLY_COMMENT
static java.lang.String	FIELD_ITEM
static java.lang.String	FIELD_MESSAGE
static java.lang.String	FIELD_MODIFIED_AT
static java.lang.String	FIELD_TAGGED_MESSAGE
static java.lang.String	TYPE

Fields inherited from class com.box.androidsdk.content.models.BoxEntity

FIELD_ID, FIELD_ITEM_ID, FIELD_ITEM_TYPE, FIELD_TYPE

Fields inherited from class com.box.androidsdk.content.models.BoxJsonObject

mProperties

Constructor Summary

Constructors

Constructor and Description
BoxComment() Constructs an empty BoxComment object.
BoxComment(java.util.Map<java.lang.String,java.lang.Object> map) Constructs a BoxComment with the provided map values.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Date	getCreatedAt() Gets the time the comment was created.
BoxUser	getCreatedBy() Gets info about the user who created the comment.
java.lang.Boolean	getIsReplyComment() Gets whether or not the comment is a reply to another comment.
BoxItem	getItem() Gets info about the item this comment is attached to.
java.lang.String	getMessage() Gets the comment's message.
java.util.Date	getModifiedAt() Gets the time the comment was last modified.
protected void	parseJSONMember(JsonObject.Member member) Invoked with a JSON member whenever this object is updated or created from a JSON object.

Methods inherited from class com.box.androidsdk.content.models.BoxEntity

createEntityFromJson, createEntityFromJson, getId, getType

Methods inherited from class com.box.androidsdk.content.models.BoxJsonObject

createFromJson, createFromJson, getPropertiesAsHashMap, parseJsonObject, parseNullJsonMember, toJson, toJsonObject

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final java.lang.String TYPE

See Also:

Constant Field Values

FIELD_IS_REPLY_COMMENT

public static final java.lang.String FIELD_IS_REPLY_COMMENT

See Also:

Constant Field Values

FIELD_MESSAGE

public static final java.lang.String FIELD_MESSAGE

See Also:

Constant Field Values

FIELD_TAGGED_MESSAGE

public static final java.lang.String FIELD_TAGGED_MESSAGE

See Also:

Constant Field Values

FIELD_CREATED_BY

public static final java.lang.String FIELD_CREATED_BY

See Also:

Constant Field Values

FIELD_CREATED_AT

public static final java.lang.String FIELD_CREATED_AT

See Also:

Constant Field Values

FIELD_ITEM

public static final java.lang.String FIELD_ITEM

See Also:

Constant Field Values

FIELD_MODIFIED_AT

public static final java.lang.String FIELD_MODIFIED_AT

See Also:

Constant Field Values

ALL_FIELDS

public static final java.lang.String[] ALL_FIELDS

Constructor Detail

BoxComment

public BoxComment()

Constructs an empty BoxComment object.

BoxComment

public BoxComment(java.util.Map<java.lang.String,java.lang.Object> map)

Constructs a BoxComment with the provided map values.

Parameters:

map - map of keys and values of the object

Method Detail

getIsReplyComment

public java.lang.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 java.lang.String getMessage()

Gets the comment's message.

Returns:

the comment's message.

getCreatedBy

public BoxUser getCreatedBy()

Gets info about the user who created the comment.

Returns:

info about the user who created the comment.

getCreatedAt

public java.util.Date getCreatedAt()

Gets the time the comment was created.

Returns:

the time the comment was created.

getItem

public BoxItem 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 or BoxBookmark.

Returns:

the item this comment is attached to.

getModifiedAt

public java.util.Date getModifiedAt()

Gets the time the comment was last modified.

Returns:

the time the comment was last modified.

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.

Overrides:

parseJSONMember in class BoxEntity

Parameters:

member - the JSON member to be parsed.