sg4e.chatur

Class ChaturBot

java.lang.Object

sg4e.chatur.ChaturBot

Direct Known Subclasses:

SimpleBot

public class ChaturBot
extends java.lang.Object

The gateway to the chat API; subclass and override relevant methods for callbacks.

Constructor Summary

Constructors

Constructor and Description
ChaturBot(java.lang.String roomName, java.lang.String URL, java.lang.String connectAuth) Creates a new instance; start() must be called to open the connection.

Method Summary

Modifier and Type	Method and Description
RoomCount	getRoomCount() Queries the server for number of users in room and returns the response asynchronously inside the RoomCount object.
java.lang.String	getRoomName() Returns the room name, as specified to the constructor.
boolean	isAuthenticated() Returns whether the authentication process with the server has succeeded yet.
protected void	onAuthResponse(com.neovisionaries.ws.client.WebSocket websocket, java.lang.String message) Called after authorization.The default implementation joins the channel specified in this instance's constructor.
protected void	onNotify(Notification notification) Called when an announcement or tip is sent.
protected void	onNotifyGroupShowCancel() Called when a group show is cancelled.
protected void	onRoomMsg(RoomMessage message) Called when a normal chat message is sent.
protected void	onSilence(java.lang.String arg0, java.lang.String arg1) Called when a user is timed out by a moderator.
protected void	onTitleChange(java.lang.String newTitle) Called on stream title change; empty strings are common because of Chaturbate's implementation.
void	start() Opens the connection and starts receiving messages from the server.
void	stop() Closes the connection and stops receiving messages form the server.

Methods inherited from class java.lang.Object

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

Constructor Detail

ChaturBot

public ChaturBot(java.lang.String roomName,
                 java.lang.String URL,
                 java.lang.String connectAuth)
          throws java.io.IOException

Creates a new instance; start() must be called to open the connection.

Parameters:

URL -

connectAuth -

roomName -

Throws:

java.io.IOException

Method Detail

start

public void start()
           throws com.neovisionaries.ws.client.WebSocketException

Opens the connection and starts receiving messages from the server.

Throws:

com.neovisionaries.ws.client.WebSocketException

stop

public void stop()

Closes the connection and stops receiving messages form the server.

getRoomCount

public RoomCount getRoomCount()

Queries the server for number of users in room and returns the response asynchronously inside the RoomCount object. See the object's documentation for how to manage the asynchronous nature of the query.

Returns:

Throws:

java.lang.IllegalStateException - if start() has not been called, or authentication with server is incomplete (see isAuthenticated().

isAuthenticated

public boolean isAuthenticated()

Returns whether the authentication process with the server has succeeded yet.

Returns:

getRoomName

public java.lang.String getRoomName()

Returns the room name, as specified to the constructor.

Returns:

onAuthResponse

protected void onAuthResponse(com.neovisionaries.ws.client.WebSocket websocket,
                              java.lang.String message)

Called after authorization.The default implementation joins the channel specified in this instance's constructor. Unless you are familiar with Chaturbate's WS protocol, do not override this method, or at least call super so that the connection process to the chat is completed.

Parameters:

websocket -

message - - raw text from websocket

onRoomMsg

protected void onRoomMsg(RoomMessage message)

Called when a normal chat message is sent.

Parameters:

message -

onTitleChange

protected void onTitleChange(java.lang.String newTitle)

Called on stream title change; empty strings are common because of Chaturbate's implementation. Consider filtering out empty strings.

Parameters:

newTitle -

onNotify

protected void onNotify(Notification notification)

Called when an announcement or tip is sent. See Notification for more info.

Parameters:

notification -

onSilence

protected void onSilence(java.lang.String arg0,
                         java.lang.String arg1)

Called when a user is timed out by a moderator. One of these parameters is the moderator and the other is the receiver of the timeout.

Parameters:

arg0 -

arg1 -

onNotifyGroupShowCancel

protected void onNotifyGroupShowCancel()

Called when a group show is cancelled.