org.relayirc.chatengine
Interface IChatEngine

All Known Implementing Classes:

ChatEngine

public interface IChatEngine

Interface for a chat engine. Where possible, use it instead of ChatEngine.

See Also:

ChatEngine, ChatEngineListener

Method Summary

void	addChatEngineListener(ChatEngineListener listener) Add a chat engine listener.
void	connect() Connect to server specified by current chat-options.
void	disconnect() Disconnect from server.
void	fireStatusEvent(java.lang.String statusMsg) Fire status event to listeners.
java.lang.String	getAppName() Get app name to be reported to version queries.
java.lang.String	getAppVersion() Get app version to be reported to version queries.
java.lang.String	getNick() Get nick name currently in use.
boolean	isConnected() Check connection status.
boolean	isConnecting() Check connection status.
void	processUserInput(java.lang.String txt, java.lang.String chan) Process input from user.
void	removeChatEngineListener(ChatEngineListener listener) Remove a chat engine listener.
void	sendCommand(java.lang.String cmd) Send command string directly to server.
void	sendJoin(Channel chan) Send join message to server for specified channel.
void	sendJoin(java.lang.String chan) Send join message to server for specified channel.
void	sendMessage(java.lang.String msg, java.lang.String chan) Send private message to server.
void	sendPart(Channel chan) Send parting message to server.
void	sendPart(java.lang.String chan) Send parting message to server.
void	sendQuit(java.lang.String msg) Send quit message to server.
void	sendVersion(java.lang.String msg) Send version information to server.
void	setAppName(java.lang.String name) Set app name to be reported to version queries.
void	setAppVersion(java.lang.String version) Set app verion to be reported to version queries.
void	startChannelSearch(ChannelSearch search) Start a channel search.

Method Detail

addChatEngineListener

public void addChatEngineListener(ChatEngineListener listener)

Add a chat engine listener.

removeChatEngineListener

public void removeChatEngineListener(ChatEngineListener listener)

Remove a chat engine listener.

connect

public void connect()

Connect to server specified by current chat-options.

disconnect

public void disconnect()

Disconnect from server.

isConnected

public boolean isConnected()

Check connection status.

isConnecting

public boolean isConnecting()

Check connection status.

fireStatusEvent

public void fireStatusEvent(java.lang.String statusMsg)

Fire status event to listeners.

getNick

public java.lang.String getNick()

Get nick name currently in use.

processUserInput

public void processUserInput(java.lang.String txt,
                             java.lang.String chan)

Process input from user.

sendCommand

public void sendCommand(java.lang.String cmd)

Send command string directly to server.

sendJoin

public void sendJoin(Channel chan)

Send join message to server for specified channel.

sendJoin

public void sendJoin(java.lang.String chan)

Send join message to server for specified channel.

sendMessage

public void sendMessage(java.lang.String msg,
                        java.lang.String chan)

Send private message to server.

sendVersion

public void sendVersion(java.lang.String msg)

Send version information to server.

sendPart

public void sendPart(Channel chan)

Send parting message to server.

sendPart

public void sendPart(java.lang.String chan)

Send parting message to server.

sendQuit

public void sendQuit(java.lang.String msg)

Send quit message to server.

startChannelSearch

public void startChannelSearch(ChannelSearch search)

Start a channel search.

getAppName

public java.lang.String getAppName()

Get app name to be reported to version queries.

setAppName

public void setAppName(java.lang.String name)

Set app name to be reported to version queries.

getAppVersion

public java.lang.String getAppVersion()

Get app version to be reported to version queries.

setAppVersion

public void setAppVersion(java.lang.String version)

Set app verion to be reported to version queries.