com.leafdigital.irc.api
Class UserCommandMsg
java.lang.Object
leafchat.core.api.Msg
com.leafdigital.irc.api.UserCommandMsg
public class UserCommandMsg
- extends Msg
Message sent when user types a /-command or ordinary text
Field Summary |
static MessageInfo |
info
Message information for scripting system. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
info
public static MessageInfo info
- Message information for scripting system.
UserCommandMsg
public UserCommandMsg(Server server,
java.lang.String command,
java.lang.String params,
java.lang.String contextChan,
IRCUserAddress contextUser,
MessageDisplay md)
- Parameters:
server
- Server for command (null if none)command
- Slash-command (null if none)params
- Parameters to command (empty string if none)contextChan
- Context chan (or null)contextUser
- Context nick/user (or null)md
- Context UI object (e.g. a channel window or something)
which will be used to generate error messages resulting directly from
this command.
error
public void error(java.lang.String s)
- Call when there is an error in what the user's typed. Stops message
processing and displays the error.
- Parameters:
s
- Text of error
getMessageDisplay
public MessageDisplay getMessageDisplay()
- Returns:
- Message display for window command was issued in
getServer
public Server getServer()
- Returns:
- Server that command should run on (null if none)
getCommand
public java.lang.String getCommand()
- Returns:
- Command in lower-case, or null if none
getParams
public java.lang.String getParams()
- Returns:
- Parameters, or empty string if none
getContextChan
public java.lang.String getContextChan()
- Returns:
- Context chan (null if none)
getContextUser
public IRCUserAddress getContextUser()
- Returns:
- Context user (null if none)
Copyright © 2011 Samuel Marshall. All rights reserved.