org.xwiki.ircbot
Interface IRCBotListener<T extends org.pircbotx.PircBotX>

Type Parameters:

T - the reference to the PircBotX instance

All Superinterfaces:

org.pircbotx.hooks.Listener<T>

@Role
public interface IRCBotListener<T extends org.pircbotx.PircBotX>
extends org.pircbotx.hooks.Listener<T>

IRC Bot Listeners allows to perform some actions in answer to some IRC channel event. For example you may want to code a Bot Listener that would do something when a given word is typed on the IRC channel.

Since:

4.0M2

Version:

$Id: 36ea8b88d9ed1b3bb6f3b9b37995954bdef5e1ae $

Method Summary

String	getDescription()
String	getName()

Methods inherited from interface org.pircbotx.hooks.Listener

onEvent

Method Detail

getName

String getName()

Returns:

the human-readable name of the Bot Listener (eg "Displays the list of command available when you type '!help'")

getDescription

String getDescription()

Returns:

the Bot listener's description