Uses of Class
leafchat.core.api.Msg

Packages that use Msg
com.leafdigital.irc.api The IRC api provides low-level support for the events and communication involved in connection with an IRC server. 
com.leafdigital.ircui.api The IRC UI plugin API allows plugins to add actions that are available in a particular context so that these can appear on right-click menus. 
com.leafdigital.notification.api   
com.leafdigital.prefs.api The preferences API provides a low-level way for plugins to store and retrieve their preferences. 
leafchat.core.api leafChat's core API, available to all plugins. 
 

Uses of Msg in com.leafdigital.irc.api
 

Subclasses of Msg in com.leafdigital.irc.api
 class ChanActionIRCMsg
          Action message (/me)
 class ChanCTCPRequestIRCMsg
          Notice sent to a channel
 class ChanIRCMsg
          IRC message sent to a channel
 class ChanMessageIRCMsg
          Normal message sent to a channel
 class ChanModeIRCMsg
          Mode change to a channel
 class ChanNoticeIRCMsg
          Notice sent to a channel
 class ErrorIRCMsg
          IRC 'error' message that is received when the server drops connection.
 class IgnoreListChangeMsg
          Sent when the ignore list changes
 class InviteIRCMsg
          Invite message
 class IRCMsg
          Represents a parsed message received from an IRC server, parsed
 class JoinIRCMsg
          JOIN to a channel
 class KickIRCMsg
          Somebody is kicked from channel
 class NickIRCMsg
          Nickname change
 class NumericIRCMsg
          Numeric IRC message.
 class OffWatchMsg
          Message sent when a watched user goes offline
 class OnWatchMsg
          Message sent when a 'watched' user comes online
 class PartIRCMsg
          Somebody leaves a channel
 class PingIRCMsg
          IRC ping message
 class QuitIRCMsg
          User quit
 class ServerConnectedMsg
          Sent once a socket connection has been opened to an IRC server
 class 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)
 class ServerDisconnectedMsg
          Sent once a socket connection has been lost to an IRC server
 class ServerIRCMsg
          IRC message that has a server as prefix
 class ServerLineMsg
          Represents the lowest level of IRC communication: a line received from the server.
 class ServerMsg
          Any communication from or to an IRC server
 class ServerNoticeIRCMsg
          Represents a server NOTICE
 class ServerRearrangeMsg
          Sent to inform the UI part that the server preferences could be rearranged if user confirms it.
 class ServerSendMsg
          Communication to be sent to an IRC server.
 class SilenceIRCMsg
          Silence information
 class TopicIRCMsg
          Shows the current/changed topic on channel
 class UnknownIRCMsg
          Represents messages which could not be recognised
 class UserActionIRCMsg
          Action message
 class UserCommandListMsg
          Message sent to get a list of available / commands.
 class UserCommandMsg
          Message sent when user types a /-command or ordinary text
 class UserCTCPRequestIRCMsg
          CTCP request sent to a user
 class UserCTCPResponseIRCMsg
          CTCP response from a user
 class UserIRCMsg
          IRC message sent to a user
 class UserMessageIRCMsg
          Message sent to a user
 class UserModeIRCMsg
          User mode change
 class UserNoticeIRCMsg
          Notice sent to a user
 class UserSourceIRCMsg
          IRC message that has a user as prefix
 class WatchListChangeMsg
          Sent when the ignore list changes
 class WatchMsg
          Represents a parsed message received from an IRC server, parsed
 

Methods in com.leafdigital.irc.api with parameters of type Msg
 boolean UserFilter.accept(Msg m)
           
 boolean ServerFilter.accept(Msg m)
           
 boolean NumericFilter.accept(Msg m)
           
 boolean NickFilter.accept(Msg m)
           
 boolean NickAndServerFilter.accept(Msg m)
           
 boolean CTCPCommandFilter.accept(Msg m)
           
 boolean CommandFilter.accept(Msg m)
           
 boolean ChanFilter.accept(Msg m)
           
 boolean ChanAndServerFilter.accept(Msg m)
           
 

Uses of Msg in com.leafdigital.ircui.api
 

Subclasses of Msg in com.leafdigital.ircui.api
 class IRCActionListMsg
          Message that is sent when building a list of actions, for example when somebody right-clicks on a nickname or the like.
 

Uses of Msg in com.leafdigital.notification.api
 

Subclasses of Msg in com.leafdigital.notification.api
 class NotificationListMsg
          Message sent to identify available notification types.
 

Uses of Msg in com.leafdigital.prefs.api
 

Subclasses of Msg in com.leafdigital.prefs.api
 class PreferencesChangeMsg
          Sent when preferences change.
 

Uses of Msg in leafchat.core.api
 

Subclasses of Msg in leafchat.core.api
 class ErrorMsg
          Sent when an error has occurred and should be reported to the user.
 class MinuteMsg
          Message sent every minute
 class PluginUnloadMsg
          Message sent when a plugin is being unloaded.
 class SystemStateMsg
          Message sent when leafChat has loaded all plugins and is ready to start up
 

Methods in leafchat.core.api that return types with arguments of type Msg
 java.lang.Class<? extends Msg> MsgOwner.getMessageClass()
          Return the public class of messages dispatched by this object.
 java.lang.Class<? extends Msg> MessageInfo.getMessageClass()
           
 

Methods in leafchat.core.api with parameters of type Msg
 boolean MinuteFilter.accept(Msg m)
           
 boolean MessageFilter.accept(Msg m)
          Simple version of message filter.
 boolean MsgOwner.allowExternalDispatch(Msg m)
          Called if somebody tries to dispatch a message other than via the MessageDispatch class
 boolean BasicMsgOwner.allowExternalDispatch(Msg m)
           
 boolean PluginContext.dispatchExternalMessage(java.lang.Class<? extends Msg> message, Msg m, boolean immediate)
          Dispatch a message that is controlled by a MessageOwner in another plugin.
 void MessageDispatch.dispatchMessage(Msg m, boolean immediate)
          Dispatches a message.
 void MessageDispatch.dispatchMessageHandleErrors(Msg m, boolean immediate)
          Does exactly the same as dispatchMessage but without throwing exceptions.
 void PluginContext.dispatchMsgToTarget(Msg m, java.lang.Object target)
          Dispatch message to a specific target (useful for re-handling your own messages, basically just calls the right msg() method).
 void MsgOwner.manualDispatch(Msg m)
          Called when the dispatcher should handle manual dispatch of a message (to all targets for which it returned false in registerTarget).
 void BasicMsgOwner.manualDispatch(Msg m)
           
 boolean Msg.sequenceBefore(Msg consider)
          Checks whether this message ought to run before the message under consideration.
 void Msg.setSequence(Msg relative)
          Indicates that this message should belong to the same sequence as some other message (i.e. this one is presumably being dispatched in response to that one).
 

Method parameters in leafchat.core.api with type arguments of type Msg
 boolean PluginContext.dispatchExternalMessage(java.lang.Class<? extends Msg> message, Msg m, boolean immediate)
          Dispatch a message that is controlled by a MessageOwner in another plugin.
 MessageInfo PluginContext.getMessageInfo(java.lang.Class<? extends Msg> c)
          Obtains information about any available message type.
 void PluginContext.registerExtraMessageClass(java.lang.Class<? extends Msg> c)
          Registers an additional message class (apart from the base type).
 boolean MsgOwner.registerTarget(java.lang.Object target, java.lang.Class<? extends Msg> message, MessageFilter mf, int requestID, int priority)
          Called when a new target registers to receive messages from this class.
 boolean BasicMsgOwner.registerTarget(java.lang.Object target, java.lang.Class<? extends Msg> message, MessageFilter mf, int requestID, int priority)
           
 int PluginContext.requestMessages(java.lang.Class<? extends Msg> message, java.lang.Object target)
          Requests messages of a particular type, with no filter and PRIORITY_NORMAL.
 int PluginContext.requestMessages(java.lang.Class<? extends Msg> message, java.lang.Object target, int priority)
          Requests messages of a particular type, with no filter.
 int PluginContext.requestMessages(java.lang.Class<? extends Msg> message, java.lang.Object target, MessageFilter mf)
          Requests messages of a particular type, with PRIORITY_NORMAL.
 int PluginContext.requestMessages(java.lang.Class<? extends Msg> message, java.lang.Object target, MessageFilter mf, int priority)
          Requests messages of a particular type.
 void PluginContext.unrequestMessages(java.lang.Class<? extends Msg> message, java.lang.Object target, int requestID)
          Cancels a request for messages.
 

Constructor parameters in leafchat.core.api with type arguments of type Msg
MessageInfo(java.lang.Class<? extends Msg> c)
          Constructs with a particular message class and a default name (the class name without Msg).
MessageInfo(java.lang.Class<? extends Msg> c, java.lang.String name, java.lang.String description)
          Constructs with a particular message class.
 



Copyright © 2011 Samuel Marshall. All rights reserved.