xyz.nickr.jitter.api.event

Interface RoomReadMessagesEvent

All Superinterfaces:

JitterEvent

All Known Implementing Classes:

RoomReadMessagesEventImpl

public interface RoomReadMessagesEvent
extends JitterEvent

Represents an event of when the current user "reads" messages.

Author:

Nick Robson

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	asJSON() Gets the underlying JSON object.
String[]	getMessageIds() Gets the message identifiers.
Room	getRoom() Gets the room in which this event occurred.
boolean	isUnread() Gets whether or not this event represents new messages or reading old messages.

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.

getMessageIds

String[] getMessageIds()

Gets the message identifiers.

Returns:

The identifiers.

isUnread

boolean isUnread()

Gets whether or not this event represents new messages or reading old messages.

Returns:

True if new messages, false otherwise.

getRoom

Room getRoom()

Gets the room in which this event occurred.

Returns:

The room.