xyz.nickr.jitter.api

Interface Room

All Known Implementing Classes:

RoomImpl

public interface Room

Represents a Gitter room or channel.

Author:

Nick Robson

Method Summary

Modifier and Type	Method and Description
org.json.JSONObject	asJSON() Gets the underlying JSON object.
default void	beginEventsStreaming() Makes this room start streaming room events through the event API.
default void	beginMessageStreaming() Makes this room start streaming messages through the event API.
List<Room>	getChannels() Gets this room's subchannels.
String	getID() Gets this room's ID.
Jitter	getJitter() Gets the providing Jitter object.
String	getLastAccessTime() Gets the time this room was last accessed.
Message	getMessage(String id) Gets the Message of a given ID.
MessageHistory	getMessageHistory() Gets this room's message history.
MessageHistory	getMessagesAfter(Message message) Gets this room's message history, with messages after and including the given message.
MessageHistory	getMessagesBefore(Message message) Gets this room's message history, with messages before and including the given message.
String	getName() Gets this room's name.
String	getPathURL() Gets this room's URL path.
List<String>	getTags() Gets this room's tags.
String	getTopic() Gets this room's topic.
RoomType	getType() Gets this room's type.
int	getUnreadItems() Gets the number of unread messages in this room.
int	getUnreadMentions() Gets the number of unread mentions in this room.
String	getURI() Gets this room's URI.
int	getUserCount() Gets this room's user count.
List<RoomUser>	getUsers() Loads and returns this room's users.
int	getVersion() Gets this room's version.
boolean	isFavourite() Gets whether or not this room is marked as a favourite room.
boolean	isLurkEnabled() Gets whether or not the authenticated is lurking in this room.
boolean	isMember() Gets whether or not the current user is a member of this room.
Message	sendMessage(String message) Sends a message to this room.
void	update(org.json.JSONObject data) Updates this Room with the given JSON data.

Method Detail

getJitter

Jitter getJitter()

Gets the providing Jitter object.

Returns:

The provider.

asJSON

org.json.JSONObject asJSON()

Gets the underlying JSON object.

Returns:

The JSON.

getID

String getID()

Gets this room's ID.

Returns:

The ID.

getName

String getName()

Gets this room's name.

Returns:

The name.

getTopic

String getTopic()

Gets this room's topic.

Returns:

The topic.

getType

RoomType getType()

Gets this room's type.

Returns:

The type.

getURI

String getURI()

Gets this room's URI.

Returns:

The URI.

getUserCount

int getUserCount()

Gets this room's user count.

Returns:

The user count.

getUnreadItems

int getUnreadItems()

Gets the number of unread messages in this room.

Returns:

The count.

getUnreadMentions

int getUnreadMentions()

Gets the number of unread mentions in this room.

Returns:

The count.

getLastAccessTime

String getLastAccessTime()

Gets the time this room was last accessed.

Returns:

The time it was last accessed.

isMember

boolean isMember()

Gets whether or not the current user is a member of this room.

Returns:

True if it is; false otherwise.

isFavourite

boolean isFavourite()

Gets whether or not this room is marked as a favourite room.

Returns:

True if it is; false otherwise.

isLurkEnabled

boolean isLurkEnabled()

Gets whether or not the authenticated is lurking in this room.

Returns:

True if it is; false otherwise.

getPathURL

String getPathURL()

Gets this room's URL path.

Returns:

The URL path.

getTags

List<String> getTags()

Gets this room's tags.

Returns:

The tags.

getVersion

int getVersion()

Gets this room's version.

Returns:

The version.

getChannels

List<Room> getChannels()

Gets this room's subchannels.

Returns:

The subchannels.

getUsers

List<RoomUser> getUsers()

Loads and returns this room's users.

Note: This is a potentially costly operation if there are lots of users. Caching is a good idea for this.

Returns:

The users.

getMessage

Message getMessage(String id)

Gets the Message of a given ID.

Parameters:

id - The ID.

Returns:

The message, or null if no such message.

getMessageHistory

MessageHistory getMessageHistory()

Gets this room's message history.

Returns:

The message history;

getMessagesBefore

MessageHistory getMessagesBefore(Message message)

Gets this room's message history, with messages before and including the given message.

Parameters:

message - The message.

Returns:

The message history.

getMessagesAfter

MessageHistory getMessagesAfter(Message message)

Gets this room's message history, with messages after and including the given message.

Parameters:

message - The message.

Returns:

The message history.

sendMessage

Message sendMessage(String message)

Sends a message to this room.

Parameters:

message - The message.

Returns:

The message.

beginMessageStreaming

default void beginMessageStreaming()

Makes this room start streaming messages through the event API.

beginEventsStreaming

default void beginEventsStreaming()

Makes this room start streaming room events through the event API.

update

void update(org.json.JSONObject data)

Updates this Room with the given JSON data.

Parameters:

data - The data.