org.sobotics.chatexchange.chat.event

Class PingMessageEvent

java.lang.Object

org.sobotics.chatexchange.chat.event.Event

org.sobotics.chatexchange.chat.event.MessageEvent

org.sobotics.chatexchange.chat.event.PingMessageEvent

Direct Known Subclasses:

MessageReplyEvent, UserMentionedEvent

public abstract class PingMessageEvent
extends MessageEvent

Represents an event that is the result of ping message action. A ping corresponds to a message that either replies to another message (with the :{messageId} chat feature) or mentions a user (with the @{userName} chat feature).

It is a notification sent to the user, that will also appear in their global inbox, if not acknowleged before that.

Author:

Tunaki

Method Summary

Modifier and Type	Method and Description
long	getParentMessageId() Returns the message id that this event's message is pinging.
long	getTargetUserId() Returns the user id that was pinged by this event.

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

getMessage

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

getTargetUserId

public long getTargetUserId()

Returns the user id that was pinged by this event.

Returns:

Id of the user that was pinged by this event.

getParentMessageId

public long getParentMessageId()

Returns the message id that this event's message is pinging. It will correspond to a message made by the targeted user. For replies, it corresponds to the message that was replied to; for mentions, it corresponds to the latest message of that user.

If the parent message cannot be found, for example in the case where the parent message pinged several users at the same time, this returns -1.

Returns:

Id of the message that this event's message is pinging, or -1 if the message cannot be found.