org.sobotics.chatexchange.chat

Class Room

java.lang.Object

org.sobotics.chatexchange.chat.Room

public final class Room
extends Object

Method Summary

Modifier and Type	Method and Description
<T> void	addEventListener(EventType<T> event, Consumer<T> listener) Adds a listener for the given event.
CompletionStage<Void>	delete(long messageId) Deletes asynchronously the message having the given id.
CompletionStage<Long>	edit(long messageId, String message) Edits asynchronously the message having the given id with the new given content.
List<User>	getCurrentUsers() Returns the list of all the current users of this room.
ChatHost	getHost() Returns the host of this room.
Message	getMessage(long messageId) Retrieves the Message having the given id.
List<User>	getPingableUsers() Returns the list of all the pingable users of this room.
int	getRoomId() Returns the id of this room.
RoomThumbs	getThumbs() Returns the thumbs for this chat room.
User	getUser(long userId) Retrieves the User having the given id.
boolean	isEditable(long messageId) Returns whether this message can be edited as of now.
void	leave() Causes the current logged user to leave the room.
CompletionStage<Long>	replyTo(long messageId, String message) Sends a reply message to the given message id.
CompletionStage<Long>	send(String message) Sends the given message asynchronously.
CompletionStage<Void>	togglePin(long messageId) Pins or unpins the given message.
CompletionStage<Void>	toggleStar(long messageId) Stars or unstars the given message.
CompletionStage<String>	uploadImage(Path path) Uploads the given file and returns the HTTP URL to the file hosted on imgur.
CompletionStage<String>	uploadImage(String fileName, InputStream inputStream) Uploads the given file and returns the HTTP URL to the file hosted on imgur.

Methods inherited from class java.lang.Object

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

Method Detail

addEventListener

public <T> void addEventListener(EventType<T> event,
                                 Consumer<T> listener)

Adds a listener for the given event. Valid events are defined as constants of the EventType class.

All listeners bound to a specific event will be called when the corresponding event is raised.

Type Parameters:

T - type of the event.

Parameters:

event - Event to listen to.

listener - Listener to add to this event.

send

public CompletionStage<Long> send(String message)

Sends the given message asynchronously.

Parameters:

message - Content of the message to send.

Returns:

A future holding the id of the sent message.

uploadImage

public CompletionStage<String> uploadImage(Path path)

Uploads the given file and returns the HTTP URL to the file hosted on imgur.

Parameters:

path - Path of the file to upload.

Returns:

URL of the uploaded image.

uploadImage

public CompletionStage<String> uploadImage(String fileName,
                                           InputStream inputStream)

Uploads the given file and returns the HTTP URL to the file hosted on imgur.

This method is asynchronous, thus, if the given input stream needs to be closed, make sure to properly close it in a CompletionStage.whenComplete(java.util.function.BiConsumer) callback on the returned stage.

Parameters:

fileName - Name of the file to upload.

inputStream - Data.

Returns:

URL of the uploaded image.

replyTo

public CompletionStage<Long> replyTo(long messageId,
                                     String message)

Sends a reply message to the given message id.

Parameters:

messageId - Id of the message to reply to.

message - Message consisting of the reply.

Returns:

A future holding the id of the newly sent message.

edit

public CompletionStage<Long> edit(long messageId,
                                  String message)

Edits asynchronously the message having the given id with the new given content.

Parameters:

messageId - Id of the message to edit.

message - New content of the message.

Returns:

A future holding the id of the edited message (which is the same as the given message id).

isEditable

public boolean isEditable(long messageId)

Returns whether this message can be edited as of now. This doesn't guarantee that a subsequent call to edit(long, String) will be successful, because the time window allowed for the edit could have been passed by then. However, if a call to edit(long, String) is made right after this method returns true then it is very likely to succeed (i.e. not fail because the edit window has elapsed; it can still fail for other reasons).

A message can be edited if it has been posted less than seconds ago.

Parameters:

messageId - Id of the message.

Returns:

true if the given message can be edited right now, false otherwise.

delete

public CompletionStage<Void> delete(long messageId)

Deletes asynchronously the message having the given id.

Parameters:

messageId - Id of the message to delete.

Returns:

A future holding no value.

toggleStar

public CompletionStage<Void> toggleStar(long messageId)

Stars or unstars the given message. This method acts like a toggle, by starring the message if this user didn't star it before, or by unstarring it if this user starred it before.

Parameters:

messageId - Id of the message to star / unstar.

Returns:

A future holding no value.

togglePin

public CompletionStage<Void> togglePin(long messageId)

Pins or unpins the given message. This method acts like a toggle, by pinning the message if this user didn't pin it before, or by unpinning it if this user pin it before.

Parameters:

messageId - Id of the message to pin / unpin.

Returns:

A future holding no value.

leave

public void leave()

Causes the current logged user to leave the room.

Calling this method multiple times has no effect.

getMessage

public Message getMessage(long messageId)

Retrieves the Message having the given id.

Parameters:

messageId - Id of the message to fetch.

Returns:

Message with the given id.

getPingableUsers

public List<User> getPingableUsers()

Returns the list of all the pingable users of this room.

This consists of all the users that have been in the room at least once for the past 14 days.

Returns:

List of pingable users of this room.

getCurrentUsers

public List<User> getCurrentUsers()

Returns the list of all the current users of this room.

This consists of all the users that are present, at the moment of this call, in the room.

Returns:

List of current users of this room.

getUser

public User getUser(long userId)

Retrieves the User having the given id.

Parameters:

userId - Id of the user to fetch.

Returns:

User with the given id.

getRoomId

public int getRoomId()

Returns the id of this room. This id needs to be combined with the host of this room to reference uniquely this room, as there can be rooms with the same id across multiple hosts.

Returns:

Id of this room.

getThumbs

public RoomThumbs getThumbs()

Returns the thumbs for this chat room. This includes various informations such as: name, description...

Refer to RoomThumbs for a description of all the fields.

Returns:

Thumbs for this chat room

getHost

public ChatHost getHost()

Returns the host of this room.

Returns:

Host of this room.