com.leafdigital.ircui.api
Class NickAction
java.lang.Object
com.leafdigital.ircui.api.AbstractIRCAction
com.leafdigital.ircui.api.NickAction
- All Implemented Interfaces:
- IRCAction
public class NickAction
- extends AbstractIRCAction
- implements IRCAction
Convenience class for IRCActions that take a single nickname or multiple
selected nicknames.
Constructor Summary |
NickAction(PluginContext pc,
java.lang.String name,
int category,
int order,
java.lang.String command)
|
Method Summary |
void |
run(Server s,
java.lang.String contextChannel,
java.lang.String contextNick,
java.lang.String selectedChannel,
java.lang.String[] selectedNicks,
MessageDisplay caller)
Called when the action should actually run. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
NickAction
public NickAction(PluginContext pc,
java.lang.String name,
int category,
int order,
java.lang.String command)
- Parameters:
pc
- Contextname
- Menu namecategory
- Category constantorder
- Order within categorycommand
- IRC command to run, with %%NICK%% for nickname, for each name
run
public void run(Server s,
java.lang.String contextChannel,
java.lang.String contextNick,
java.lang.String selectedChannel,
java.lang.String[] selectedNicks,
MessageDisplay caller)
- Description copied from interface:
IRCAction
- Called when the action should actually run.
- Specified by:
run
in interface IRCAction
- Parameters:
s
- ServercontextChannel
- Context channel (the one the user's action happened in)contextNick
- Context nick (the one the user's action happened in)selectedChannel
- Selected channel (one which was actively chosen)selectedNicks
- Selected nicks (which were actively chosen)caller
- Reference to window that should be used to display messages
if needed
Copyright © 2011 Samuel Marshall. All rights reserved.