C# Class IRC.Commands

Show file Open project: tamaw/SharpIRC

Public Methods

Method Description
Admin ( this client, string target = "" ) : void

The admin command is used to find information about the administrator of the given server, or current server if parameter is omitted. Each server MUST have the ability to forward ADMIN messages to other servers.

Away ( this client, string text = "" ) : void
Connect ( this client, string target, string port, string remote = "" ) : void

The CONNECT command can be used to request a server to try to establish a new connection to another server immediately. CONNECT is a privileged command and SHOULD be available only to IRC Operators.

Die ( this client ) : void
Info ( this client, string target = "" ) : void

The INFO command is REQUIRED to return information describing the server: its version, when it was compiled, the patchlevel, when it was started, and any other miscellaneous information which may be considered to be relevant.

Invite ( this client, string nickname, string channel ) : void
Ison ( this client, string nickname ) : void
Join ( this client, string name, string key = "" ) : void
Kick ( this client, string channel, string user, string comment = "" ) : void
Kill ( this client, string nickname, string comment ) : void
LUsers ( this client, string mask = "", string target = "" ) : void
Links ( this client, string server = "", string mask = "" ) : void
List ( this client, string channels = null ) : void
Mode ( this client, string nickname, string mode ) : void
Mode ( this client, string name, string modes, string modeParams ) : void
Names ( this client ) : void
Names ( this client, string channel ) : void
Nick ( this client, string nickname ) : void
Notice ( this client, string msgTarget, string text ) : void
Oper ( this client, string name, string password ) : void
Part ( this client, string name, string message = "" ) : void
Pass ( this client, string password ) : void
Ping ( this client, string server1, string server2 = "" ) : void
Pong ( this client, string server, string server2 = "" ) : void
PrivMsg ( this client, string msgTarget, string message ) : void
Quit ( this client, string message = "" ) : void
Rehash ( this client ) : void

The rehash command is an administrative command which can be used by an operator to force the server to re-read and process its configuration file.

Restart ( this client ) : void
SQuery ( this client, string servicename, string text ) : void

The SQUERY command is used similarly to PRIVMSG. The only difference is that the recipient MUST be a service. This is the only way for a text message to be delivered to a service.

SQuit ( this client, string server, string comment ) : void
ServList ( this client, string mask = "", string type = "" ) : void

The SERVLIST command is used to list services currently connected to the network and visible to the user issuing the command. The optional parameters may be used to restrict the result of the query (to matching services names, and services type).

Service ( this client, string nickname, string type, string reserved, string info ) : void
Stats ( this client, string query = "", string target = "" ) : void
Summon ( this client, string user, string target = "", string channel = "" ) : void
Target ( this client, string target = "" ) : void
Time ( this client, string target = "" ) : void
Topic ( this client, string name ) : void
Topic ( this client, string channel, string topic ) : void
Trace ( this client, string target = "" ) : void
User ( this client, string user, User mode, string realname ) : void
UserHost ( this client, string nickname ) : void
Version ( this client, string target = "" ) : void
WallOps ( this client, string text ) : void
Who ( this client, string mask = "" ) : void

The WHO command is used by a client to generate a query which returns a list of information which 'matches' the parameter given by the client. In the absence of the parameter, all visible (users who aren't invisible (user mode +i) and who don't have a common channel with the requesting client) are listed. The same result can be achieved by using a of "0" or any wildcard which will end up matching every visible user.

WhoIs ( this client, string mask = "", string target = "" ) : void
WhoWas ( this client, string nickname, string count = "", string target = "" ) : void

Method Details

Admin() public static method

The admin command is used to find information about the administrator of the given server, or current server if parameter is omitted. Each server MUST have the ability to forward ADMIN messages to other servers.
public static Admin ( this client, string target = "" ) : void
client this
target string
return void

Away() public static method

public static Away ( this client, string text = "" ) : void
client this
text string
return void

Connect() public static method

The CONNECT command can be used to request a server to try to establish a new connection to another server immediately. CONNECT is a privileged command and SHOULD be available only to IRC Operators.
public static Connect ( this client, string target, string port, string remote = "" ) : void
client this
target string
port string
remote string
return void

Die() public static method

public static Die ( this client ) : void
client this
return void

Info() public static method

The INFO command is REQUIRED to return information describing the server: its version, when it was compiled, the patchlevel, when it was started, and any other miscellaneous information which may be considered to be relevant.
public static Info ( this client, string target = "" ) : void
client this
target string
return void

Invite() public static method

public static Invite ( this client, string nickname, string channel ) : void
client this
nickname string
channel string
return void

Ison() public static method

public static Ison ( this client, string nickname ) : void
client this
nickname string
return void

Join() public static method

public static Join ( this client, string name, string key = "" ) : void
client this
name string
key string
return void

Kick() public static method

public static Kick ( this client, string channel, string user, string comment = "" ) : void
client this
channel string
user string
comment string
return void

Kill() public static method

public static Kill ( this client, string nickname, string comment ) : void
client this
nickname string
comment string
return void

LUsers() public static method

public static LUsers ( this client, string mask = "", string target = "" ) : void
client this
mask string
target string
return void

Links() public static method

public static Links ( this client, string server = "", string mask = "" ) : void
client this
server string
mask string
return void

List() public static method

public static List ( this client, string channels = null ) : void
client this
channels string
return void

Mode() public static method

public static Mode ( this client, string nickname, string mode ) : void
client this
nickname string
mode string
return void

Mode() public static method

public static Mode ( this client, string name, string modes, string modeParams ) : void
client this
name string
modes string
modeParams string
return void

Names() public static method

public static Names ( this client ) : void
client this
return void

Names() public static method

public static Names ( this client, string channel ) : void
client this
channel string
return void

Nick() public static method

public static Nick ( this client, string nickname ) : void
client this
nickname string
return void

Notice() public static method

public static Notice ( this client, string msgTarget, string text ) : void
client this
msgTarget string
text string
return void

Oper() public static method

public static Oper ( this client, string name, string password ) : void
client this
name string
password string
return void

Part() public static method

public static Part ( this client, string name, string message = "" ) : void
client this
name string
message string
return void

Pass() public static method

public static Pass ( this client, string password ) : void
client this
password string
return void

Ping() public static method

public static Ping ( this client, string server1, string server2 = "" ) : void
client this
server1 string
server2 string
return void

Pong() public static method

public static Pong ( this client, string server, string server2 = "" ) : void
client this
server string
server2 string
return void

PrivMsg() public static method

public static PrivMsg ( this client, string msgTarget, string message ) : void
client this
msgTarget string
message string
return void

Quit() public static method

public static Quit ( this client, string message = "" ) : void
client this
message string
return void

Rehash() public static method

The rehash command is an administrative command which can be used by an operator to force the server to re-read and process its configuration file.
public static Rehash ( this client ) : void
client this
return void

Restart() public static method

public static Restart ( this client ) : void
client this
return void

SQuery() public static method

The SQUERY command is used similarly to PRIVMSG. The only difference is that the recipient MUST be a service. This is the only way for a text message to be delivered to a service.
public static SQuery ( this client, string servicename, string text ) : void
client this
servicename string
text string
return void

SQuit() public static method

public static SQuit ( this client, string server, string comment ) : void
client this
server string
comment string
return void

ServList() public static method

The SERVLIST command is used to list services currently connected to the network and visible to the user issuing the command. The optional parameters may be used to restrict the result of the query (to matching services names, and services type).
public static ServList ( this client, string mask = "", string type = "" ) : void
client this
mask string
type string
return void

Service() public static method

public static Service ( this client, string nickname, string type, string reserved, string info ) : void
client this
nickname string
type string
reserved string
info string
return void

Stats() public static method

public static Stats ( this client, string query = "", string target = "" ) : void
client this
query string
target string
return void

Summon() public static method

public static Summon ( this client, string user, string target = "", string channel = "" ) : void
client this
user string
target string
channel string
return void

Target() public static method

public static Target ( this client, string target = "" ) : void
client this
target string
return void

Time() public static method

public static Time ( this client, string target = "" ) : void
client this
target string
return void

Topic() public static method

public static Topic ( this client, string name ) : void
client this
name string
return void

Topic() public static method

public static Topic ( this client, string channel, string topic ) : void
client this
channel string
topic string
return void

Trace() public static method

public static Trace ( this client, string target = "" ) : void
client this
target string
return void

User() public static method

public static User ( this client, string user, User mode, string realname ) : void
client this
user string
mode User
realname string
return void

UserHost() public static method

public static UserHost ( this client, string nickname ) : void
client this
nickname string
return void

Version() public static method

public static Version ( this client, string target = "" ) : void
client this
target string
return void

WallOps() public static method

public static WallOps ( this client, string text ) : void
client this
text string
return void

Who() public static method

The WHO command is used by a client to generate a query which returns a list of information which 'matches' the parameter given by the client. In the absence of the parameter, all visible (users who aren't invisible (user mode +i) and who don't have a common channel with the requesting client) are listed. The same result can be achieved by using a of "0" or any wildcard which will end up matching every visible user.
public static Who ( this client, string mask = "" ) : void
client this
mask string The <mask> passed to WHO is matched against users' host, server, real /// name and nickname if the channel cannot be found.
return void

WhoIs() public static method

public static WhoIs ( this client, string mask = "", string target = "" ) : void
client this
mask string
target string
return void

WhoWas() public static method

public static WhoWas ( this client, string nickname, string count = "", string target = "" ) : void
client this
nickname string
count string
target string
return void