org.xwiki.ircbot.wiki
Interface WikiIRCBotListenerManager

All Known Implementing Classes:
DefaultWikiIRCBotListenerManager

@Role
public interface WikiIRCBotListenerManager

Registers/unregisters Wiki Bot Listeners.

Since:
4.0M2

Method Summary
 void registerWikiBotListener(DocumentReference reference)
          Register (and thus activate) the Wiki Bot Listener defined in the passed document's reference.
 void registerWikiBotListeners()
          Register (and thus activate) all the Wiki Bot Listeners found in the current wiki.
 void unregisterWikiBotListener(DocumentReference reference)
          Unregister (and thus deactivate) the Wiki Bot Listener defined in the passed document's reference.
 void unregisterWikiBotListeners()
          Unregister (and thus deactivate) all the Wiki Bot Listeners found in the current wiki.
 

Method Detail

registerWikiBotListener

void registerWikiBotListener(DocumentReference reference)
                             throws IRCBotException
Register (and thus activate) the Wiki Bot Listener defined in the passed document's reference.

Parameters:
reference - the reference of the document containing the Wiki Bot Listener definition
Throws:
IRCBotException - if any error happens

unregisterWikiBotListener

void unregisterWikiBotListener(DocumentReference reference)
                               throws IRCBotException
Unregister (and thus deactivate) the Wiki Bot Listener defined in the passed document's reference.

Parameters:
reference - the reference of the document containing the Wiki Bot Listener definition
Throws:
IRCBotException - if any error happens

registerWikiBotListeners

void registerWikiBotListeners()
                              throws IRCBotException
Register (and thus activate) all the Wiki Bot Listeners found in the current wiki.

Throws:
IRCBotException - if any error happens

unregisterWikiBotListeners

void unregisterWikiBotListeners()
                                throws IRCBotException
Unregister (and thus deactivate) all the Wiki Bot Listeners found in the current wiki.

Throws:
IRCBotException - if any error happens