Relay-IRC API: Interface ChannelListener

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.relayirc.chatengine
Interface ChannelListener

All Known Implementing Classes:: ChannelAdapter, ChannelPanel

public interface ChannelListener

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

Author:: David M. Johnson
The contents of this file are subject to the Mozilla Public License Version 1.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/
Original Code: Relay IRC Chat Engine
Initial Developer: David M. Johnson
Contributor(s): No contributors to this file
Copyright (C) 1997-2000 by David M. Johnson
All Rights Reserved.
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 onJoins(ChannelEvent event)
          Multiple users have 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 onNick(ChannelEvent event)
          A user has changed nick names.

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

public void onActivation(ChannelEvent event)

Channel has been activated, given focus or brought-to-front. Event includes no originating user, subject user or value.

onAction

public 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

public void onConnect(ChannelEvent event)

Server has connected/joined the channel. Event includes no originating user, subject user or value.

onDisconnect

public void onDisconnect(ChannelEvent event)

Server has disconnected/parted the channel. Event includes no originating user, subject user or value.

onMessage

public 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

public 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.

onJoins

public void onJoins(ChannelEvent event)

Multiple users have joined the channel. Event's value is a String containing a list of user nick names who are currently on a channel you just joined.

onPart

public void onPart(ChannelEvent event)

A user has parted/left the channel. Event includes origin nick, origin address.

onBan

public 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

public 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

public 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.

onOp

public 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

public 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

public 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

public void onTopicChange(ChannelEvent event)

Channel topic has changed. The event's value is a sting containing the new topic.