io.supportkit.core

Class Message

java.lang.Object

io.supportkit.core.Message

All Implemented Interfaces:

java.io.Serializable

public final class Message
extends java.lang.Object
implements java.io.Serializable

Object representing a received or sent message

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getAvatarUrl() The url for the author's avatar image.
java.util.Date	getDate() The date and time the message was sent.
java.util.List<MessageAction>	getMessageActions() The list of Message Action objects representing the message.
java.lang.String	getName() The name of the author.
java.lang.String	getText() The text content of the message.
MessageUploadStatus	getUploadStatus() The upload status of the message.
int	hashCode()
boolean	isFromCurrentUser() Returns true if the message originated from the user, or false if the message comes from the app team.
boolean	isRead() Return true if the message has been read
boolean	isWhisper() Returns true if the message was generated by a Whisper.

Methods inherited from class java.lang.Object

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

Method Detail

getAvatarUrl

public java.lang.String getAvatarUrl()

The url for the author's avatar image.

Returns:

The url

getDate

public java.util.Date getDate()

The date and time the message was sent.

Returns:

The date

isFromCurrentUser

public boolean isFromCurrentUser()

Returns true if the message originated from the user, or false if the message comes from the app team.

Returns:

Is the message from the current user

isWhisper

public boolean isWhisper()

Returns true if the message was generated by a Whisper.

Returns:

Is the message generated by a Whisper

getMessageActions

public java.util.List<MessageAction> getMessageActions()

The list of Message Action objects representing the message.

Returns:

The message actions

getName

public java.lang.String getName()

The name of the author. This property may be null if no name could be determined.

Returns:

The name

getText

public java.lang.String getText()

The text content of the message.

Returns:

The text

getUploadStatus

public MessageUploadStatus getUploadStatus()

The upload status of the message.

Returns:

The status

isRead

public boolean isRead()

Return true if the message has been read

Returns:

Flag indicating that the message has been read

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object