xyz.nickr.jitter.api.event

Interface RoomEvent

All Superinterfaces:

JitterEvent

All Known Implementing Classes:

RoomEventImpl

public interface RoomEvent
extends JitterEvent

Represents an event that is broadcast in a room.

For example, if issue tracking is enabled in the room, an event is called when an event is opened/closed/reopened/tagged.

Author:

Nick Robson

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	asJSON() Gets the underlying JSON object.
String	getAction() Gets the action that the event describes.
Optional<Date>	getEditTimestamp() Gets the date when this event was edited.
String	getHTML() Gets the HTML representation of the event.
String	getID() Gets the event's ID.
org.json.JSONObject	getMetadata() Gets the JSON object describing this event's metadata.
org.json.JSONObject	getPayload() Gets the JSON object describing this event's payload.
Room	getRoom() Gets the room in which this event occurred.
Date	getSentTimestamp() Gets the date when this event was sent.
String	getService() Gets the name of the service that called the event.
String	getText() Gets the text representation of the event.
Optional<User>	getUser() Gets the user that triggered the event.
int	getVersion() Gets this event's version.

Methods inherited from interface xyz.nickr.jitter.api.event.JitterEvent

getJitter

Method Detail

asJSON

org.json.JSONObject asJSON()

Gets the underlying JSON object.

Returns:

The JSON.

getID

String getID()

Gets the event's ID.

Returns:

The ID.

getService

String getService()

Gets the name of the service that called the event.

Returns:

The service name.

getAction

String getAction()

Gets the action that the event describes.

Returns:

The action.

getText

String getText()

Gets the text representation of the event.

Returns:

The text.

getHTML

String getHTML()

Gets the HTML representation of the event.

Returns:

The HTML.

getRoom

Room getRoom()

Gets the room in which this event occurred.

Returns:

The room.

getSentTimestamp

Date getSentTimestamp()

Gets the date when this event was sent.

Returns:

The date.

getEditTimestamp

Optional<Date> getEditTimestamp()

Gets the date when this event was edited.

Returns:

The date, if it exists.

getUser

Optional<User> getUser()

Gets the user that triggered the event.

Returns:

The user, if existent.

getMetadata

org.json.JSONObject getMetadata()

Gets the JSON object describing this event's metadata.

Returns:

The metadata.

getPayload

org.json.JSONObject getPayload()

Gets the JSON object describing this event's payload.

Returns:

The payload.

getVersion

int getVersion()

Gets this event's version.

Returns:

The version.