com.leafdigital.irc.api
Class UserCTCPRequestIRCMsg

java.lang.Object
  extended by leafchat.core.api.Msg
      extended by com.leafdigital.irc.api.IRCMsg
          extended by com.leafdigital.irc.api.UserSourceIRCMsg
              extended by com.leafdigital.irc.api.UserIRCMsg
                  extended by com.leafdigital.irc.api.UserCTCPRequestIRCMsg
Direct Known Subclasses:
UserActionIRCMsg

public class UserCTCPRequestIRCMsg
extends UserIRCMsg

CTCP request sent to a user


Field Summary
static MessageInfo info
          Scripting event information.
 
Fields inherited from class leafchat.core.api.Msg
PRIORITY_AFTERNORMAL, PRIORITY_BEFORENORMAL, PRIORITY_EARLY, PRIORITY_FIRST, PRIORITY_LAST, PRIORITY_LATE, PRIORITY_NORMAL
 
Constructor Summary
UserCTCPRequestIRCMsg(IRCUserAddress source, java.lang.String nick, java.lang.String request, byte[] text)
           
 
Method Summary
 java.lang.String getRequest()
           
 byte[] getText()
           
 boolean hasResponded()
           
 void markResponded()
          Indicates that the client has sent a response to this message
 java.lang.String toString()
           
 
Methods inherited from class com.leafdigital.irc.api.UserIRCMsg
getTargetNick
 
Methods inherited from class com.leafdigital.irc.api.UserSourceIRCMsg
getSourceUser
 
Methods inherited from class com.leafdigital.irc.api.IRCMsg
constructBytes, constructBytes, convertEncoding, convertISO, getCommand, getCommandBytes, getLine, getLineISO, getParamISO, getParams, getPrefix, getPrefixBytes, getServer, hasEncoding, includesPostfix, init, init, isParamInteger, setEncoding, splitBytes
 
Methods inherited from class leafchat.core.api.Msg
isHandled, isStopped, markHandled, markStopped, sequenceBefore, setSequence, setSequence
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

info

public static MessageInfo info
Scripting event information.

Constructor Detail

UserCTCPRequestIRCMsg

public UserCTCPRequestIRCMsg(IRCUserAddress source,
                             java.lang.String nick,
                             java.lang.String request,
                             byte[] text)
Parameters:
source - User that is in the message prefix
nick - Nickname of target
request - CTCP request command
text - Text/parameters of message
Method Detail

getText

public byte[] getText()
Returns:
Text or parameters of message (everything after command); zero-length if none

getRequest

public java.lang.String getRequest()
Returns:
CTCP request command (upper-case)

hasResponded

public boolean hasResponded()
Returns:
True if the client has sent a response (so that it will still be displayed, this message is not marked handled when a response is sent).

markResponded

public void markResponded()
Indicates that the client has sent a response to this message


toString

public java.lang.String toString()
Overrides:
toString in class UserIRCMsg


Copyright © 2011 Samuel Marshall. All rights reserved.