org.relayirc.chatengine
Interface ChannelListener

All Known Implementing Classes:
ChannelAdapter

public interface ChannelListener

Implement this interface to listen to channel events incuding messages, joins, parts, bans and kicks.

See Also:
Channel

Method Summary
 void onAction(ChannelEvent event)
          User has acted.
 void onActivation(ChannelEvent event)
          Channel has been activated, given focus or brought-to-front.
 void onBan(ChannelEvent event)
          An operator has banned a user from the channel.
 void onConnect(ChannelEvent event)
          Server has connected/joined the channel.
 void onDeOp(ChannelEvent event)
          An operator has taken away a users operator rights.
 void onDisconnect(ChannelEvent event)
          Server has disconnected/parted the channel.
 void onJoin(ChannelEvent event)
          A user has joined the channel.
 void onKick(ChannelEvent event)
          An operator has kicked a user from the channel.
 void onMessage(ChannelEvent event)
          A user has spoken.
 void onNames(ChannelEvent event)
          Received users who joined the channel.
 void onNick(ChannelEvent event)
          A user has changed nick names.
 void onNotice(ChannelEvent event)
          A user has spoken.
 void onOp(ChannelEvent event)
          An operator has given a user operator rights.
 void onPart(ChannelEvent event)
          A user has parted/left the channel.
 void onQuit(ChannelEvent event)
          A user has quit/disconnected from the chat server.
 void onTopicChange(ChannelEvent event)
          Channel topic has changed.
 

Method Detail

onActivation

void onActivation(ChannelEvent event)
Channel has been activated, given focus or brought-to-front. Event includes no originating user, subject user or value.


onAction

void onAction(ChannelEvent event)
User has acted. Event includes origin nick, origin address and the value is a string containing the text of the user's action.


onConnect

void onConnect(ChannelEvent event)
Server has connected/joined the channel. Event includes no originating user, subject user or value.


onDisconnect

void onDisconnect(ChannelEvent event)
Server has disconnected/parted the channel. Event includes no originating user, subject user or value.


onMessage

void onMessage(ChannelEvent event)
A user has spoken. Event includes origin nick, origin address and the value is a string containing the text of the user's message.


onJoin

void onJoin(ChannelEvent event)
A user has joined the channel. Event includes origin nick, origin address and the value is a string containing the text of the user's message.


onNames

void onNames(ChannelEvent event)
Received users who joined the channel. Event's value is a List<User> containing a list of users who are currently on a channel you just joined. The users have operator status and voice status.


onPart

void onPart(ChannelEvent event)
A user has parted/left the channel. Event includes origin nick, origin address.


onBan

void onBan(ChannelEvent event)
An operator has banned a user from the channel. Event includes origin nick, origin address, subject nick, subject nick and subject address. The origin is the operator and the subject is the banned.


onKick

void onKick(ChannelEvent event)
An operator has kicked a user from the channel. Event includes origin nick, origin address, subject nick, subject nick and subject address. The origin is the operator and the subject is the kicked.


onNick

void onNick(ChannelEvent event)
A user has changed nick names. Event includes origin nick, origin address and the value is the origin's new nick name.


onNotice

void onNotice(ChannelEvent event)
A user has spoken. Event includes origin nick, origin address and the value is a string containing the text of the user's message.


onOp

void onOp(ChannelEvent event)
An operator has given a user operator rights. Event includes origin nick, origin address, subject nick, subject nick and subject address. The origin is the operator and the subject is the reciever of rights.


onDeOp

void onDeOp(ChannelEvent event)
An operator has taken away a users operator rights. Event includes origin nick, origin address, subject nick, subject nick and subject address. The origin is the operator and the subject is the reciever of rights.


onQuit

void onQuit(ChannelEvent event)
A user has quit/disconnected from the chat server. Event includes origin nick, origin address and the value is the origin's new nick name.


onTopicChange

void onTopicChange(ChannelEvent event)
Channel topic has changed. The event's value is a sting containing the new topic.