org.sobotics.chatexchange.chat.event

Class Event

java.lang.Object

org.sobotics.chatexchange.chat.event.Event

Direct Known Subclasses:

KickedEvent, MessageEvent, UserEnteredEvent, UserLeftEvent

public abstract class Event
extends Object

Base class for all events raised in chat.

An event represents an action that was triggered by a user or a system action. Actions made by user typically corresponds to posting messages, editing messages, etc. and actions made by the system typically corresponds to feeds added, change in access level, etc.

All events have a instant at which they occured, represented by an Instant object (UTC). They also have the user that triggered the action (ID and display name), with the exception of anonymous events (like starring). For system events, the ID will be strictly negative and for anonymous events, it is will be 0.

Author:

Tunaki

Method Summary

Modifier and Type	Method and Description
Instant	getInstant() Returns the instant in time (UTC) at which this event occured.
Room	getRoom() The room this event took place.
int	getRoomId() Returns the ID of the room this event took place.
Optional<User>	getUser() Returns the user that raised this event, at the time the event was raised.
long	getUserId() Returns the id of the user that raised this event.
String	getUserName() Returns the display name of the user that raised this event.

Methods inherited from class java.lang.Object

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

Method Detail

getInstant

public Instant getInstant()

Returns the instant in time (UTC) at which this event occured.

Returns:

Instant in time (UTC) at which this event occured.

getUser

public Optional<User> getUser()

Returns the user that raised this event, at the time the event was raised.

The returned user will not be updated with regards to, e.g, reputation changes that were made after this event. If an updated user is needed, refer to Room.getUser(long).

For events where there was no registered user, or system generated event, this returns an empty Optional.

Returns:

User that raised this event.

getUserId

public long getUserId()

Returns the id of the user that raised this event.

For system generated event, the id will be strictly negative. For events where there was no registered user, this will be 0.

Returns:

Id of the user that raised this event.

See Also:

getUser()

getUserName

public String getUserName()

Returns the display name of the user that raised this event. This can be null under unreproducible conditions.

Returns:

Display name of the user that raised this event.

getRoom

public Room getRoom()

The room this event took place.

Returns:

Room this event took place.

getRoomId

public int getRoomId()

Returns the ID of the room this event took place. This is a short-hand for Room.getRoomId()

Returns:

ID of the room this event took place.

See Also:

getRoom()