B C D E G I J L N O P R S U W

B

BOTNAME_PROPERTY - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Property for the Bot's name.

BrokenLinkEventListenerConfiguration - Interface in org.xwiki.ircbot

Configuration for the Broken Link Event Listener (ie the listener that sends IRC messages when a broken link is found in the wiki).

C

CHANNEL_PROPERTY - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Property for the channel to connect to.

CONFIGURATION_PAGE - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Page containing IRC configuration data.

connect(String) - Method in interface org.xwiki.ircbot.IRCBot

Attempt to connect to the specified IRC server.

containsWikiListener(DocumentReference) - Method in interface org.xwiki.ircbot.wiki.WikiIRCBotListenerFactory

Searches the given document for a valid listener definition and for an active listener.

createWikiListener(DocumentReference) - Method in interface org.xwiki.ircbot.wiki.WikiIRCBotListenerFactory

Tries to build a WikiIRCBotListener if a definition is found on the given document.

D

DESCRIPTION_PROPERTY - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Listener description property.

disconnect() - Method in interface org.xwiki.ircbot.IRCBot

This method disconnects from the server cleanly by calling the quitServer() method.

DocumentModifiedEventListenerConfiguration - Interface in org.xwiki.ircbot

Configuration for the Document Modifier Event Listener (ie the listener that sends IRC messages when a document is modified).

E

EVENT_NAME_PROPERTY - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Listener event property.

EVENT_SCRIPT_PROPERTY - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Listener event script name property.

execute() - Method in interface org.xwiki.ircbot.wiki.WikiIRCModel.Executor

Execute some code.

executeAsUser(DocumentReference, DocumentReference, WikiIRCModel.Executor) - Method in interface org.xwiki.ircbot.wiki.WikiIRCModel

Execute some code as the passed user and using the passed document as the current security document on which permissions are verified.

G

getBotListenerData() - Method in interface org.xwiki.ircbot.wiki.WikiIRCBotManager

Provides information about all Bot Listeners (whether they are Wiki Bot Listeners or standard Java components).

getChannelsNames() - Method in interface org.xwiki.ircbot.IRCBot

Gets all the name's of all the channels that we are connected to.

getConfigurationDocument() - Method in interface org.xwiki.ircbot.wiki.WikiIRCModel

getContext() - Method in interface org.xwiki.ircbot.wiki.WikiIRCBotManager

getDescription() - Method in interface org.xwiki.ircbot.IRCBotListener

getDocument(DocumentReference) - Method in interface org.xwiki.ircbot.wiki.WikiIRCModel

getExclusionPatterns() - Method in interface org.xwiki.ircbot.DocumentModifiedEventListenerConfiguration

getListenerManager() - Method in interface org.xwiki.ircbot.IRCBot

Returns the current ListenerManager in use by this bot.

getName() - Method in interface org.xwiki.ircbot.IRCBotListener

getWikiBotListenerData() - Method in interface org.xwiki.ircbot.wiki.WikiIRCModel

getXWikiContext() - Method in interface org.xwiki.ircbot.wiki.WikiIRCModel

I

identify(String) - Method in interface org.xwiki.ircbot.IRCBot

Identify the bot with NickServ, supplying the appropriate password.

INACTIVE_PROPERTY - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Whether a Bot Listener or the Bot itself are marked inactive.

initialize(String) - Method in interface org.xwiki.ircbot.IRCBot

Initialize the IRC Bot.

IRCBot - Interface in org.xwiki.ircbot

Represents an IRC Bot.

IRCBotException - Exception in org.xwiki.ircbot

Encapsulate a parsing error.

IRCBotException(String) - Constructor for exception org.xwiki.ircbot.IRCBotException

Construct a new Exception with the specified detail message.

IRCBotException(String, Throwable) - Constructor for exception org.xwiki.ircbot.IRCBotException

Construct a new Exception with the specified detail message and cause.

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

IRC Bot Listeners allows to perform some actions in answer to some IRC channel event.

isActive() - Method in interface org.xwiki.ircbot.BrokenLinkEventListenerConfiguration

isBotStarted() - Method in interface org.xwiki.ircbot.wiki.WikiIRCBotManager

isConnected() - Method in interface org.xwiki.ircbot.IRCBot

Returns whether or not the Bot is currently connected to a server.

J

joinChannel(String) - Method in interface org.xwiki.ircbot.IRCBot

Joins a channel.

L

loadBotData() - Method in interface org.xwiki.ircbot.wiki.WikiIRCModel

N

NAME_PROPERTY - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Listener name property.

O

ON_CONNECT_EVENT_NAME - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Listener event property value for the onConnect event.

ON_DISCONNECT_EVENT_NAME - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Listener event property value for the onDisconnect event.

ON_JOIN_EVENT_NAME - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Listener event property value for the onJoin event.

ON_MESSAGE_EVENT_NAME - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Listener event property value for the onMessage event.

ON_NICK_CHANGE_EVENT_NAME - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Listener event property value for the onNickChange event.

ON_PART_EVENT_NAME - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Listener event property value for the onPart event.

ON_PRIVATE_MESSAGE_EVENT_NAME - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Listener event property value for the onPrivateMessage event.

ON_QUIT_EVENT_NAME - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Listener event property value for the onQuit event.

ON_REGISTRATION_EVENT_NAME - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Listener event property value for the onRegistration event.

ON_UNREGISTRATION_EVENT_NAME - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Listener event property value for the onUnregistration event.

org.xwiki.ircbot - package org.xwiki.ircbot

org.xwiki.ircbot.wiki - package org.xwiki.ircbot.wiki

P

PASSWORD_PROPERTY - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Property for the password to identify the user with the IRC server.

R

registerWikiBotListener(DocumentReference) - Method in interface org.xwiki.ircbot.wiki.WikiIRCBotListenerManager

Register (and thus activate) the Wiki Bot Listener defined in the passed document's reference.

registerWikiBotListeners() - Method in interface org.xwiki.ircbot.wiki.WikiIRCBotListenerManager

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

S

sendMessage(String, String) - Method in interface org.xwiki.ircbot.IRCBot

Sends a message to a channel or a private message to a user.

SERVER_PROPERTY - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Property for the Server to connect to.

setActive(boolean) - Method in interface org.xwiki.ircbot.wiki.WikiIRCModel

setName(String) - Method in interface org.xwiki.ircbot.IRCBot

Sets the name of the bot, which will be used as its nick when it tries to join an IRC server.

SPACE - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Space where the IRC Bot pages are located.

startBot(boolean) - Method in interface org.xwiki.ircbot.wiki.WikiIRCBotManager

Connects the IRC Bot using the Configuration data located in WikiIRCBotConstants.WIKI_BOT_CONFIGURATION_CLASS and registers all Wiki Bot Listeners that are not marked as inactive.

stopBot(boolean) - Method in interface org.xwiki.ircbot.wiki.WikiIRCBotManager

Disconnect the IRC Bot and unregister all Wiki Bot Listeners.

U

unregisterWikiBotListener(DocumentReference) - Method in interface org.xwiki.ircbot.wiki.WikiIRCBotListenerManager

Unregister (and thus deactivate) the Wiki Bot Listener defined in the passed document's reference.

unregisterWikiBotListeners() - Method in interface org.xwiki.ircbot.wiki.WikiIRCBotListenerManager

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

W

WIKI_BOT_CONFIGURATION_CLASS - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

Constant for representing IRC.IRCBot xwiki class which is the Bot's configuration class.

WIKI_BOT_LISTENER_CLASS - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

IRC.IRCBotListenerClass xwiki class.

WIKI_BOT_LISTENER_EVENT_CLASS - Static variable in interface org.xwiki.ircbot.wiki.WikiIRCBotConstants

IRC.IRCBotListenerEventClass xwiki class.

WikiIRCBotConstants - Interface in org.xwiki.ircbot.wiki

Constants identifying various properties used for defining wiki IRC Bot listeners.

WikiIRCBotListenerFactory - Interface in org.xwiki.ircbot.wiki

Create a Bot Listener object by gathering the Listener metadata from a document.

WikiIRCBotListenerManager - Interface in org.xwiki.ircbot.wiki

Registers/unregisters Wiki Bot Listeners.

WikiIRCBotManager - Interface in org.xwiki.ircbot.wiki

Start/stop the Wiki IRC Bot including its Wiki Bot Listeners and provides some other APIs about the Wiki IRC Bot.

WikiIRCModel - Interface in org.xwiki.ircbot.wiki

Provides APIs to access to the Wiki Model of the Bot (ie documents in the wiki containing Bot data).

WikiIRCModel.Executor - Interface in org.xwiki.ircbot.wiki

Generic interface to execute code.

B C D E G I J L N O P R S U W