Package com.leafdigital.irc.api

The IRC api provides low-level support for the events and communication involved in connection with an IRC server.

See:
          Description

Interface Summary
Commands Singleton that runs IRC /-commands.
Connections Singleton holding references to all current server connections.
DefaultMessageDisplay Interface for obtaining a default MessageDisplay for a given server.
IgnoreList Singleton that manages the list of ignored names.
IRCEncoding Provides character encoding information.
IRCEncoding.EncodingInfo Information about encoding in a different context
IRCPrefs Includes constants used for preferences that belong to the IRC module.
MessageDisplay Interface implemented by things that can display error messages from commands.
Server Represents a low-level server connection.
Server.ConnectionProgress Interface used to report on progress of connection.
WatchList Singleton that manages the list of people being watched.
 

Class Summary
ChanActionIRCMsg Action message (/me)
ChanAndServerFilter Filters messages based on their source server and channel
ChanCTCPRequestIRCMsg Notice sent to a channel
ChanFilter Filters messages based on their source server and channel
ChanIRCMsg IRC message sent to a channel
ChanMessageIRCMsg Normal message sent to a channel
ChanModeIRCMsg Mode change to a channel
ChanModeIRCMsg.ModeChange Represents a single mode change
ChanNoticeIRCMsg Notice sent to a channel
CommandFilter Filters user command messages based on the command
CTCPCommandFilter Filters messages based on their source server and channel
ErrorIRCMsg IRC 'error' message that is received when the server drops connection.
IgnoreListChangeMsg Sent when the ignore list changes
InviteIRCMsg Invite message
IRCMsg Represents a parsed message received from an IRC server, parsed
IRCUserAddress Address of a user in "nick (exclamation) user (at) host" format.
JoinIRCMsg JOIN to a channel
KickIRCMsg Somebody is kicked from channel
NickAndServerFilter Filters messages based on their source server and nick
NickFilter Filters messages based on their source user nickname
NickIRCMsg Nickname change
NumericFilter Filters messages based on their server numeric
NumericIRCMsg Numeric IRC message.
OffWatchMsg Message sent when a watched user goes offline
OnWatchMsg Message sent when a 'watched' user comes online
PartIRCMsg Somebody leaves a channel
PingIRCMsg IRC ping message
QuitIRCMsg User quit
Server.StatusPrefix Mapping from mode letter to status prefix symbol
ServerConnectedMsg Sent once a socket connection has been opened to an IRC server
ServerConnectionFinishedMsg Sent once an IRC connection is fully connected (currently this happens after we get the 'end of MOTD' message, once the server stops sending stuff)
ServerDisconnectedMsg Sent once a socket connection has been lost to an IRC server
ServerFilter Filters messages based on their source server
ServerIRCMsg IRC message that has a server as prefix
ServerLineMsg Represents the lowest level of IRC communication: a line received from the server.
ServerMsg Any communication from or to an IRC server
ServerNoticeIRCMsg Represents a server NOTICE
ServerRearrangeMsg Sent to inform the UI part that the server preferences could be rearranged if user confirms it.
ServerSendMsg Communication to be sent to an IRC server.
SilenceIRCMsg Silence information
TopicIRCMsg Shows the current/changed topic on channel
UnknownIRCMsg Represents messages which could not be recognised
UserActionIRCMsg Action message
UserCommandListMsg Message sent to get a list of available / commands.
UserCommandMsg Message sent when user types a /-command or ordinary text
UserCTCPRequestIRCMsg CTCP request sent to a user
UserCTCPResponseIRCMsg CTCP response from a user
UserFilter Filters messages based on their source user nickname, username, and host
UserIRCMsg IRC message sent to a user
UserMessageIRCMsg Message sent to a user
UserModeIRCMsg User mode change
UserNoticeIRCMsg Notice sent to a user
UserSourceIRCMsg IRC message that has a user as prefix
WatchListChangeMsg Sent when the ignore list changes
WatchMsg Represents a parsed message received from an IRC server, parsed
 

Exception Summary
NetworkException Exception that occurs due to networking error
 

Package com.leafdigital.irc.api Description

The IRC api provides low-level support for the events and communication involved in connection with an IRC server.



Copyright © 2011 Samuel Marshall. All rights reserved.