org.sobotics.chatexchange.chat.event

Class MessageEvent

java.lang.Object

org.sobotics.chatexchange.chat.event.Event

org.sobotics.chatexchange.chat.event.MessageEvent

Direct Known Subclasses:

MessageDeletedEvent, MessageEditedEvent, MessagePostedEvent, MessageStarredEvent, PingMessageEvent

public abstract class MessageEvent
extends Event

Represents an event that is the result of an action being performed on a message. This is the base class for all messages type events, like posting, editing, replying, etc.

The content of the message sent by the chat event is HTML encoded: this class will unescape the HTML entities.

Author:

Tunaki

Method Summary

Modifier and Type	Method and Description
Message	getMessage() Returns the message that triggered this event, at the time the event was raised.

Methods inherited from class org.sobotics.chatexchange.chat.event.Event

getInstant, getRoom, getRoomId, getUser, getUserId, getUserName

Methods inherited from class java.lang.Object

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

Method Detail

getMessage

public Message getMessage()

Returns the message that triggered this event, at the time the event was raised.

The returned message will not be updated with regards to, e.g, stars or edits that were made after this event. If an updated message is needed, refer to Room.getMessage(long).

Returns:

Message.