com.box.sdkgen.managers.comments

Class CreateCommentRequestBody

Object

NullableFieldTracker

SerializableObject

CreateCommentRequestBody

All Implemented Interfaces:

Serializable

public class CreateCommentRequestBody
extends SerializableObject

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateCommentRequestBody.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected CreateCommentRequestBodyItemField	item The item to attach the comment to.
protected String	message The text of the comment.
protected String	taggedMessage The text of the comment, including `@[user_id:name]` somewhere in the message to mention another user, which will send them an email notification, letting them know they have been mentioned.

Fields inherited from class NullableFieldTracker

explicitlySetNullableFields

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CreateCommentRequestBody(CreateCommentRequestBody.Builder builder)
	CreateCommentRequestBody(String message, CreateCommentRequestBodyItemField item)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
CreateCommentRequestBodyItemField	getItem()
String	getMessage()
String	getTaggedMessage()
int	hashCode()
String	toString()

Methods inherited from class SerializableObject

getRawData, setRawData

Methods inherited from class NullableFieldTracker

getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

Methods inherited from class Object

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

Field Detail

message

protected final String message

The text of the comment.

To mention a user, use the `tagged_message` parameter instead.

taggedMessage

protected String taggedMessage

The text of the comment, including `@[user_id:name]` somewhere in the message to mention another user, which will send them an email notification, letting them know they have been mentioned.

The `user_id` is the target user's ID, where the `name` can be any custom phrase. In the Box UI this name will link to the user's profile.

If you are not mentioning another user, use `message` instead.

item

protected final CreateCommentRequestBodyItemField item

The item to attach the comment to.

Constructor Detail

CreateCommentRequestBody

public CreateCommentRequestBody(String message,
                                CreateCommentRequestBodyItemField item)

CreateCommentRequestBody

protected CreateCommentRequestBody(CreateCommentRequestBody.Builder builder)

Method Detail

getMessage

public String getMessage()

getTaggedMessage

public String getTaggedMessage()

getItem

public CreateCommentRequestBodyItemField getItem()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object