Index (PircBot 0.9.5 - Paul's Java IRC Bot Framework)

Package | Class | Use | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES

A B C D G H I J K L M N O P Q R S U V

## A

add(Object) - Method in class org.jibble.pircbot.Queue
  Adds an Object to the Queue.

## B

ban(String, String) - Method in class org.jibble.pircbot.PircBot
  Bans a user from a channel.

## C

changeNick(String) - Method in class org.jibble.pircbot.PircBot
  Attempt to change the current nick of this user.
clear() - Method in class org.jibble.pircbot.Queue
  Clears the contents of the Queue.
close() - Method in class org.jibble.pircbot.DccChat
  Closes the DCC Chat connection.
connect(String) - Method in class org.jibble.pircbot.PircBot
  Attempt to connect to the specified IRC server.
connect(String, int) - Method in class org.jibble.pircbot.PircBot
  Attempt to connect to the specified IRC server and port number.
connect(String, int, String) - Method in class org.jibble.pircbot.PircBot
  Attempt to connect to the specified IRC server using the supplied password.

## D

dccAcceptChatRequest(String, long, int) - Method in class org.jibble.pircbot.PircBot
  Attempts to accept a DCC CHAT request by a client.
DccChat - class org.jibble.pircbot.DccChat.
  This class is used to allow the bot to interact with a DCC Chat session.
DccChat(PircBot, String, String, int) - Constructor for class org.jibble.pircbot.DccChat
  The constructor connects to the DCC Chat client.
dccReceiveFile(File, long, int, int) - Method in class org.jibble.pircbot.PircBot
  Receives a file that is being sent to us by a DCC SEND request.
dccSendFile(File, String, int) - Method in class org.jibble.pircbot.PircBot
  Issues a DCC SEND request to the specified nick.
deOp(String, String) - Method in class org.jibble.pircbot.PircBot
  Removes operator privilidges from a user on a channel.
deVoice(String, String) - Method in class org.jibble.pircbot.PircBot
  Removes voice privilidges from a user on a channel.
disconnect() - Method in class org.jibble.pircbot.PircBot
  This method disconnects from the server by closing the socket and ending the threads that read from and write to the server.

## G

getFinger() - Method in class org.jibble.pircbot.PircBot
  Gets the internal finger message of the PircBot.
getLogin() - Method in class org.jibble.pircbot.PircBot
  Gets the internal login of the PircBot.
getMaxLineLength() - Method in class org.jibble.pircbot.PircBot
  Gets the maximum length of any line that is sent via the IRC protocol.
getMessageDelay() - Method in class org.jibble.pircbot.PircBot
  Returns the number of milliseconds that will be used to separate consecutive messages to the server from the outgoing message queue.
getName() - Method in class org.jibble.pircbot.PircBot
  Gets the internal name of the PircBot.
getVersion() - Method in class org.jibble.pircbot.PircBot
  Gets the internal version of the PircBot.

## H

handleLine(String) - Method in class org.jibble.pircbot.PircBot
  This method handles events when any line of text arrives from the server, then calling the appropriate method in the PircBot.
hasNext() - Method in class org.jibble.pircbot.Queue
  Returns true if the Queue is not empty.

## I

IdentServer - class org.jibble.pircbot.IdentServer.
  A simple IdentServer (also know as "The Identification Protocol").
IdentServer(PircBot, String) - Constructor for class org.jibble.pircbot.IdentServer
  Constructs and starts an instance of an IdentServer that will respond to a client with the provided login.
InputThread - class org.jibble.pircbot.InputThread.
  A Thread which reads lines from the IRC server.
InputThread(PircBot, BufferedReader, BufferedWriter) - Constructor for class org.jibble.pircbot.InputThread
  The InputThread reads lines from the IRC server and allows the PircBot to handle them.
IrcException - exception org.jibble.pircbot.IrcException.
  An IrcException class.
IrcException(String) - Constructor for class org.jibble.pircbot.IrcException
  Constructs a new IrcException.
isConnected() - Method in class org.jibble.pircbot.PircBot
  Returns whether or not the PircBot is currently connected to a server.

## J

joinChannel(String) - Method in class org.jibble.pircbot.PircBot
  Joins a channel.
joinChannel(String, String) - Method in class org.jibble.pircbot.PircBot
  Joins a channel with a key.

## K

kick(String, String) - Method in class org.jibble.pircbot.PircBot
  Kicks a user from a channel.
kick(String, String, String) - Method in class org.jibble.pircbot.PircBot
  Kicks a user from a channel, giving a reason.

## L

log(String) - Method in class org.jibble.pircbot.PircBot
  Adds a line to the log.
longToIp(long) - Method in class org.jibble.pircbot.PircBot
  A convenient method that accepts an I.P.

## M

MAX_LINE_LENGTH - Static variable in class org.jibble.pircbot.InputThread

## N

next() - Method in class org.jibble.pircbot.Queue
  Returns the Object at the front of the Queue.
NickAlreadyInUseException - exception org.jibble.pircbot.NickAlreadyInUseException.
  A NickAlreadyInUseException class.
NickAlreadyInUseException(String) - Constructor for class org.jibble.pircbot.NickAlreadyInUseException
  Constructs a new IrcException.

## O

onAction(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever an ACTION is sent from a user.
onDccChatRequest(String, String, String, long, int) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever a DCC CHAT request is sent to the PircBot.
onDccSendRequest(String, String, String, String, long, int, int) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever a DCC SEND request is sent to the PircBot.
onDeop(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a user (possibly us) gets operator status taken away.
onDeVoice(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a user (possibly us) gets voice status removed.
onDisconnect() - Method in class org.jibble.pircbot.PircBot
  This method carries out the actions to be performed when the PircBot gets disconnected.
onFinger(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever we receive a FINGER request.
onInvite(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when we are invited to a channel by a user.
onJoin(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever someone (possibly us) joins a channel which we are on.
onKick(String, String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever someone (possibly us) is kicked from any of the channels that we are in.
onMessage(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever a message is sent to a channel.
onMode(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when the mode of a channel is set.
onNickChange(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever someone (possibly us) changes nick on any of the channels that we are on.
onNotice(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever we receive a notice.
onOp(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a user (possibly us) gets granted operator status for a channel.
onPart(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever someone (possibly us) parts a channel which we are on.
onPing(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever we receive a PING request.
onPrivateMessage(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever a private message is sent to the PircBot.
onQuit(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever someone (possibly us) quits from the server.
onRemoveChannelBan(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a hostmask ban is removed from a channel.
onRemoveChannelKey(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel key is removed.
onRemoveChannelLimit(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when the user limit is removed for a channel.
onRemoveInviteOnly(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel has 'invite only' removed.
onRemoveModerated(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel has moderated mode removed.
onRemoveNoExternalMessages(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel is set to allow messages from any user, even if they are not actually in the channel.
onRemovePrivate(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel is marked as not being in private mode.
onRemoveSecret(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel has 'secret' mode removed.
onRemoveTopicProtection(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when topic protection is removed for a channel.
onServerPing(String) - Method in class org.jibble.pircbot.PircBot
  The actions to perform when a PING request comes from the server.
onServerResponse(int, String) - Method in class org.jibble.pircbot.PircBot
  This method is called when we receive a numeric response from the IRC server.
onSetChannelBan(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a user (possibly us!) gets banned from a channel.
onSetChannelKey(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel key is set.
onSetChannelLimit(String, String, String, String, int) - Method in class org.jibble.pircbot.PircBot
  Called when a user limit is set for a channel.
onSetInviteOnly(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel is set to 'invite only' mode.
onSetModerated(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel is set to 'moderated' mode.
onSetNoExternalMessages(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel is set to only allow messages from users that are in the channel.
onSetPrivate(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel is marked as being in private mode.
onSetSecret(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a channel is set to be in 'secret' mode.
onSetTopicProtection(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when topic protection is enabled for a channel.
onTime(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever we receive a TIME request.
onUnknown(String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever we receive a line from the server that the PircBot has not been programmed to recognise.
onVersion(String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  This method is called whenever we receive a VERSION request.
onVoice(String, String, String, String, String) - Method in class org.jibble.pircbot.PircBot
  Called when a user (possibly us) gets voice status granted in a channel.
op(String, String) - Method in class org.jibble.pircbot.PircBot
  Grants operator privilidges to a user on a channel.
org.jibble.pircbot - package org.jibble.pircbot
OutputThread - class org.jibble.pircbot.OutputThread.
  A Thread which is responsible for sending messages to the IRC server.
OutputThread(PircBot, Queue) - Constructor for class org.jibble.pircbot.OutputThread
  Constructs an OutputThread for the underlying PircBot.

## P

partChannel(String) - Method in class org.jibble.pircbot.PircBot
  Parts a channel.
partChannel(String, String) - Method in class org.jibble.pircbot.PircBot
  Parts a channel, giving a reason.
PircBot - class org.jibble.pircbot.PircBot.
  PircBot is a Java framework for writing IRC bots quickly and easily.
PircBot() - Constructor for class org.jibble.pircbot.PircBot
  Constructs a PircBot with the default settings.

## Q

Queue - class org.jibble.pircbot.Queue.
  Queue is a definition of a data structure that may act as a queue - that is, data can be added to one end of the queue and data can be requested from the head end of the queue.
Queue() - Constructor for class org.jibble.pircbot.Queue
  Constructs a Queue object of unlimited size.
quitServer() - Method in class org.jibble.pircbot.PircBot
  Quits from the IRC server.
quitServer(String) - Method in class org.jibble.pircbot.PircBot
  Quits from the IRC server with a reason.

## R

readLine() - Method in class org.jibble.pircbot.DccChat
  Reads the next line of text from the client at the other end of our DCC Chat connection.
run() - Method in class org.jibble.pircbot.IdentServer
  Waits for a client to connect to the ident server before making an appropriate response.
run() - Method in class org.jibble.pircbot.InputThread
  Called to start this Thread reading lines from the IRC server.
run() - Method in class org.jibble.pircbot.OutputThread
  This method starts the Thread consuming from the outgoing message Queue and sending lines to the server.

## S

sendAction(String, String) - Method in class org.jibble.pircbot.PircBot
  Sends an action to the channel or to a user.
sendCTCPCommand(String, String) - Method in class org.jibble.pircbot.PircBot
  Sends a CTCP command to a channel or user.
sendInvite(String, String) - Method in class org.jibble.pircbot.PircBot
  Sends an invitation to join a channel.
sendLine(String) - Method in class org.jibble.pircbot.DccChat
  Sends a line of text to the client at the other end of our DCC Chat connection.
sendMessage(String, String) - Method in class org.jibble.pircbot.PircBot
  Sends a message to a channel or a private message to a user.
sendNotice(String, String) - Method in class org.jibble.pircbot.PircBot
  Sends a notice to the channel or to a user.
sendRawLine(String) - Method in class org.jibble.pircbot.InputThread
  Sends a raw line to the IRC server as soon as possible, bypassing the outgoing message queue.
sendRawLine(String) - Method in class org.jibble.pircbot.PircBot
  Sends a raw line to the IRC server as soon as possible, bypassing the outgoing message queue.
setFinger(String) - Method in class org.jibble.pircbot.PircBot
  Sets the interal finger message.
setLogin(String) - Method in class org.jibble.pircbot.PircBot
  Sets the interal login of the Bot.
setMessageDelay(long) - Method in class org.jibble.pircbot.PircBot
  Sets the number of milliseconds to delay between consecutive messages when there are multiple messages waiting in the outgoing message queue.
setMode(String, String) - Method in class org.jibble.pircbot.PircBot
  Set the mode of a channel.
setName(String) - Method in class org.jibble.pircbot.PircBot
  Sets the internal name of the Bot.
setTopic(String, String) - Method in class org.jibble.pircbot.PircBot
  Set the topic for a channel.
setVerbose(boolean) - Method in class org.jibble.pircbot.PircBot
  Sets the verbose mode.
setVersion(String) - Method in class org.jibble.pircbot.PircBot
  Sets the internal version of the Bot.
size() - Method in class org.jibble.pircbot.Queue
  Returns the size of the Queue.
startIdentServer() - Method in class org.jibble.pircbot.PircBot
  Starts an ident server (Identification Protocol Server, RFC 1413).

## U

unBan(String, String) - Method in class org.jibble.pircbot.PircBot
  Unbans a user from a channel.

## V

VERSION - Static variable in class org.jibble.pircbot.PircBot
  The definitive version number of this release of PircBot.
voice(String, String) - Method in class org.jibble.pircbot.PircBot
  Grants voice privilidges to a user on a channel.

A B C D G H I J K L M N O P Q R S U V

Package | Class | Use | Tree | Deprecated | Index | Help
PREV NEXT | FRAMES NO FRAMES