org.xwiki.ircbot.wiki
Interface WikiIRCBotConstants

public interface WikiIRCBotConstants

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

Since:

4.0M2

Version:

$Id: fca607cd3df08d10a4c2e0c0bb3dd0e42854faf7 $

Field Summary

static String	BOTNAME_PROPERTY Property for the Bot's name.
static String	CHANNEL_PROPERTY Property for the channel to connect to.
static String	CONFIGURATION_PAGE Page containing IRC configuration data.
static String	DESCRIPTION_PROPERTY Listener description property.
static String	EVENT_NAME_PROPERTY Listener event property.
static String	EVENT_SCRIPT_PROPERTY Listener event script name property.
static String	INACTIVE_PROPERTY Whether a Bot Listener or the Bot itself are marked inactive.
static String	NAME_PROPERTY Listener name property.
static String	ON_CONNECT_EVENT_NAME Listener event property value for the onConnect event.
static String	ON_DISCONNECT_EVENT_NAME Listener event property value for the onDisconnect event.
static String	ON_JOIN_EVENT_NAME Listener event property value for the onJoin event.
static String	ON_MESSAGE_EVENT_NAME Listener event property value for the onMessage event.
static String	ON_NICK_CHANGE_EVENT_NAME Listener event property value for the onNickChange event.
static String	ON_PART_EVENT_NAME Listener event property value for the onPart event.
static String	ON_PRIVATE_MESSAGE_EVENT_NAME Listener event property value for the onPrivateMessage event.
static String	ON_QUIT_EVENT_NAME Listener event property value for the onQuit event.
static String	ON_REGISTRATION_EVENT_NAME Listener event property value for the onRegistration event.
static String	ON_UNREGISTRATION_EVENT_NAME Listener event property value for the onUnregistration event.
static String	PASSWORD_PROPERTY Property for the password to identify the user with the IRC server.
static String	SERVER_PROPERTY Property for the Server to connect to.
static String	SPACE Space where the IRC Bot pages are located.
static org.xwiki.model.reference.EntityReference	WIKI_BOT_CONFIGURATION_CLASS Constant for representing IRC.IRCBot xwiki class which is the Bot's configuration class.
static org.xwiki.model.reference.EntityReference	WIKI_BOT_LISTENER_CLASS IRC.IRCBotListenerClass xwiki class.
static org.xwiki.model.reference.EntityReference	WIKI_BOT_LISTENER_EVENT_CLASS IRC.IRCBotListenerEventClass xwiki class.

Field Detail

SPACE

static final String SPACE

Space where the IRC Bot pages are located.

See Also:

Constant Field Values

WIKI_BOT_LISTENER_CLASS

static final org.xwiki.model.reference.EntityReference WIKI_BOT_LISTENER_CLASS

IRC.IRCBotListenerClass xwiki class.

NAME_PROPERTY

static final String NAME_PROPERTY

Listener name property.

See Also:

Constant Field Values

DESCRIPTION_PROPERTY

static final String DESCRIPTION_PROPERTY

Listener description property.

See Also:

Constant Field Values

INACTIVE_PROPERTY

static final String INACTIVE_PROPERTY

Whether a Bot Listener or the Bot itself are marked inactive. If so they're not started.

See Also:

Constant Field Values

WIKI_BOT_LISTENER_EVENT_CLASS

static final org.xwiki.model.reference.EntityReference WIKI_BOT_LISTENER_EVENT_CLASS

IRC.IRCBotListenerEventClass xwiki class. There's one such object per event (i.e. per onXXX() method handled).

EVENT_NAME_PROPERTY

static final String EVENT_NAME_PROPERTY

Listener event property.

See Also:

Constant Field Values

EVENT_SCRIPT_PROPERTY

static final String EVENT_SCRIPT_PROPERTY

Listener event script name property.

See Also:

Constant Field Values

ON_REGISTRATION_EVENT_NAME

static final String ON_REGISTRATION_EVENT_NAME

Listener event property value for the onRegistration event.

See Also:

Constant Field Values

ON_UNREGISTRATION_EVENT_NAME

static final String ON_UNREGISTRATION_EVENT_NAME

Listener event property value for the onUnregistration event.

See Also:

Constant Field Values

ON_CONNECT_EVENT_NAME

static final String ON_CONNECT_EVENT_NAME

Listener event property value for the onConnect event.

See Also:

Constant Field Values

ON_DISCONNECT_EVENT_NAME

static final String ON_DISCONNECT_EVENT_NAME

Listener event property value for the onDisconnect event.

See Also:

Constant Field Values

ON_JOIN_EVENT_NAME

static final String ON_JOIN_EVENT_NAME

Listener event property value for the onJoin event.

See Also:

Constant Field Values

ON_MESSAGE_EVENT_NAME

static final String ON_MESSAGE_EVENT_NAME

Listener event property value for the onMessage event.

See Also:

Constant Field Values

ON_NICK_CHANGE_EVENT_NAME

static final String ON_NICK_CHANGE_EVENT_NAME

Listener event property value for the onNickChange event.

See Also:

Constant Field Values

ON_PART_EVENT_NAME

static final String ON_PART_EVENT_NAME

Listener event property value for the onPart event.

See Also:

Constant Field Values

ON_PRIVATE_MESSAGE_EVENT_NAME

static final String ON_PRIVATE_MESSAGE_EVENT_NAME

Listener event property value for the onPrivateMessage event.

See Also:

Constant Field Values

ON_QUIT_EVENT_NAME

static final String ON_QUIT_EVENT_NAME

Listener event property value for the onQuit event.

See Also:

Constant Field Values

WIKI_BOT_CONFIGURATION_CLASS

static final org.xwiki.model.reference.EntityReference WIKI_BOT_CONFIGURATION_CLASS

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

CONFIGURATION_PAGE

static final String CONFIGURATION_PAGE

Page containing IRC configuration data.

See Also:

Constant Field Values

BOTNAME_PROPERTY

static final String BOTNAME_PROPERTY

Property for the Bot's name.

See Also:

Constant Field Values

CHANNEL_PROPERTY

static final String CHANNEL_PROPERTY

Property for the channel to connect to.

See Also:

Constant Field Values

SERVER_PROPERTY

static final String SERVER_PROPERTY

Property for the Server to connect to.

See Also:

Constant Field Values

PASSWORD_PROPERTY

static final String PASSWORD_PROPERTY

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

See Also:

Constant Field Values