358 lines
16 KiB
HTML
358 lines
16 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
|
<title>IRCClient: NSObject(IRCClientChannelDelegate) Class Reference</title>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css">
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<!-- Generated by Doxygen 1.5.7.1 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>NSObject(IRCClientChannelDelegate) Class Reference</h1><!-- doxytag: class="NSObject(IRCClientChannelDelegate)" -->Receives delegate messages from an <a class="el" href="interface_i_r_c_client_channel.html" title="Represents a connected IRC Channel.">IRCClientChannel</a>.
|
|
<a href="#_details">More...</a>
|
|
<p>
|
|
<code>#import <<a class="el" href="_i_r_c_client_channel_delegate_8h-source.html">IRCClientChannelDelegate.h</a>></code>
|
|
<p>
|
|
|
|
<p>
|
|
<a href="class_n_s_object_07_i_r_c_client_channel_delegate_08-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
|
|
<tr><td></td></tr>
|
|
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_n_s_object_07_i_r_c_client_channel_delegate_08.html#d3e8a2612f8b6e2d65b407a0dffcd68b">onJoin:</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_n_s_object_07_i_r_c_client_channel_delegate_08.html#5e606c4445b697158029bcf99949eb40">onPart:reason:</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_n_s_object_07_i_r_c_client_channel_delegate_08.html#96106caa4eb6dc9f36a4a2ad7536de9a">onMode:params:nick:</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_n_s_object_07_i_r_c_client_channel_delegate_08.html#a1672182357b1768c817238a23564b7e">onTopic:nick:</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_n_s_object_07_i_r_c_client_channel_delegate_08.html#681261027838b019ea101a75c836a487">onKick:reason:byNick:</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_n_s_object_07_i_r_c_client_channel_delegate_08.html#2414fbf1731d8b70a79bc071e25d8d33">onPrivmsg:nick:</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_n_s_object_07_i_r_c_client_channel_delegate_08.html#6d73e8a2cb435d1f28d954104c0bd3c1">onNotice:nick:</a></td></tr>
|
|
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_n_s_object_07_i_r_c_client_channel_delegate_08.html#79d5aa388db46960369ccbd250b8a5b5">onAction:nick:</a></td></tr>
|
|
|
|
</table>
|
|
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
|
Receives delegate messages from an <a class="el" href="interface_i_r_c_client_channel.html" title="Represents a connected IRC Channel.">IRCClientChannel</a>.
|
|
<p>
|
|
Each <a class="el" href="interface_i_r_c_client_channel.html" title="Represents a connected IRC Channel.">IRCClientChannel</a> object needs a delegate. Delegate methods are called for each event that occurs on an IRC channel that the client is current on.<p>
|
|
Note that for any given parameter, it may be optional, in which case a nil object may be supplied instead of the given parameter. <hr><h2>Member Function Documentation</h2>
|
|
<a class="anchor" name="79d5aa388db46960369ccbd250b8a5b5"></a><!-- doxytag: member="NSObject(IRCClientChannelDelegate)::onAction:nick:" ref="79d5aa388db46960369ccbd250b8a5b5" args="(NSString *action,[nick] NSString *nick)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (void) onAction: </td>
|
|
<td></td>
|
|
<td class="paramtype">(NSString *) </td>
|
|
<td class="paramname"> <em>action</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey">nick:</td>
|
|
<td></td>
|
|
<td class="paramtype">(NSString *) </td>
|
|
<td class="paramname"> <em>nick</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Received when an IRC client sends a CTCP ACTION message to the channel. used by lamers with no life to pretend that they are playing some form of MMORPG.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>action</em> </td><td>the action message sent to the channel. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>nick</em> </td><td>the nickname of the IRC client that sent the message. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="d3e8a2612f8b6e2d65b407a0dffcd68b"></a><!-- doxytag: member="NSObject(IRCClientChannelDelegate)::onJoin:" ref="d3e8a2612f8b6e2d65b407a0dffcd68b" args="(NSString *nick)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (void) onJoin: </td>
|
|
<td></td>
|
|
<td class="paramtype">(NSString *) </td>
|
|
<td class="paramname"> <em>nick</em> </td>
|
|
<td> </td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
When a client joins this channel, the onJoin event is fired. Note that the nickname is most likely in nick!user@host format, but may simply be a nickname, depending on the server implementation.<p>
|
|
You should also expect to see this event when the client first joins a channel, with a parameter of the client's nickname.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>nick</em> </td><td>The nickname of the user that joined the channel. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="681261027838b019ea101a75c836a487"></a><!-- doxytag: member="NSObject(IRCClientChannelDelegate)::onKick:reason:byNick:" ref="681261027838b019ea101a75c836a487" args="(NSString *nick,[reason] NSString *reason,[byNick] NSString *byNick)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (void) onKick: </td>
|
|
<td></td>
|
|
<td class="paramtype">(NSString *) </td>
|
|
<td class="paramname"> <em>nick</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey">reason:</td>
|
|
<td></td>
|
|
<td class="paramtype">(NSString *) </td>
|
|
<td class="paramname"> <em>reason</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey">byNick:</td>
|
|
<td></td>
|
|
<td class="paramtype">(NSString *) </td>
|
|
<td class="paramname"> <em>byNick</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Received when an IRC client is kicked from a channel.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>nick</em> </td><td>nickname of the client that was kicked </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>reason</em> </td><td>reason message given for the kick </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>byNick</em> </td><td>nickname of the client that performed the kick command </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="96106caa4eb6dc9f36a4a2ad7536de9a"></a><!-- doxytag: member="NSObject(IRCClientChannelDelegate)::onMode:params:nick:" ref="96106caa4eb6dc9f36a4a2ad7536de9a" args="(NSString *mode,[params] NSString *params,[nick] NSString *nick)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (void) onMode: </td>
|
|
<td></td>
|
|
<td class="paramtype">(NSString *) </td>
|
|
<td class="paramname"> <em>mode</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey">params:</td>
|
|
<td></td>
|
|
<td class="paramtype">(NSString *) </td>
|
|
<td class="paramname"> <em>params</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey">nick:</td>
|
|
<td></td>
|
|
<td class="paramtype">(NSString *) </td>
|
|
<td class="paramname"> <em>nick</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Received when an IRC client changes the channel mode. What modes are available for a given channel is an implementation detail for each server.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>the new channel mode. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>params</em> </td><td>any parameters with the mode (such as channel key). </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>nick</em> </td><td>the nickname of the IRC client that changed the mode. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="6d73e8a2cb435d1f28d954104c0bd3c1"></a><!-- doxytag: member="NSObject(IRCClientChannelDelegate)::onNotice:nick:" ref="6d73e8a2cb435d1f28d954104c0bd3c1" args="(NSString *notice,[nick] NSString *nick)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (void) onNotice: </td>
|
|
<td></td>
|
|
<td class="paramtype">(NSString *) </td>
|
|
<td class="paramname"> <em>notice</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey">nick:</td>
|
|
<td></td>
|
|
<td class="paramtype">(NSString *) </td>
|
|
<td class="paramname"> <em>nick</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Received when an IRC client sends a public NOTICE to the channel. Note that the user may not necessarily be required to be on the channel to send a notice to it. Furthermore, the RFC states that the only difference between PRIVMSG and NOTICE is that a NOTICE may never be responded to automatically.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>notice</em> </td><td>the notice sent to the channel. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>nick</em> </td><td>the nickname of the IRC client that sent the notice. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="5e606c4445b697158029bcf99949eb40"></a><!-- doxytag: member="NSObject(IRCClientChannelDelegate)::onPart:reason:" ref="5e606c4445b697158029bcf99949eb40" args="(NSString *nick,[reason] NSString *reason)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (void) onPart: </td>
|
|
<td></td>
|
|
<td class="paramtype">(NSString *) </td>
|
|
<td class="paramname"> <em>nick</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey">reason:</td>
|
|
<td></td>
|
|
<td class="paramtype">(NSString *) </td>
|
|
<td class="paramname"> <em>reason</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
When an IRC client parts a channel you are connect to, you will see an onPart event. You will also see this event when you part a channel.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>nick</em> </td><td>(required) The nickname of the user that left the channel. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>reason</em> </td><td>(optional) The reason, if any, that the user gave for leaving. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="2414fbf1731d8b70a79bc071e25d8d33"></a><!-- doxytag: member="NSObject(IRCClientChannelDelegate)::onPrivmsg:nick:" ref="2414fbf1731d8b70a79bc071e25d8d33" args="(NSString *message,[nick] NSString *nick)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (void) onPrivmsg: </td>
|
|
<td></td>
|
|
<td class="paramtype">(NSString *) </td>
|
|
<td class="paramname"> <em>message</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey">nick:</td>
|
|
<td></td>
|
|
<td class="paramtype">(NSString *) </td>
|
|
<td class="paramname"> <em>nick</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Received when an IRC client sends a public PRIVMSG to the channel. Note that the user may not necessarily be required to be on the channel to send a message to it.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>message</em> </td><td>the message sent to the channel. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>nick</em> </td><td>the nickname of the IRC client that sent the message. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<a class="anchor" name="a1672182357b1768c817238a23564b7e"></a><!-- doxytag: member="NSObject(IRCClientChannelDelegate)::onTopic:nick:" ref="a1672182357b1768c817238a23564b7e" args="(NSString *aTopic,[nick] NSString *nick)" -->
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">- (void) onTopic: </td>
|
|
<td></td>
|
|
<td class="paramtype">(NSString *) </td>
|
|
<td class="paramname"> <em>aTopic</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td class="paramkey">nick:</td>
|
|
<td></td>
|
|
<td class="paramtype">(NSString *) </td>
|
|
<td class="paramname"> <em>nick</em></td><td> </td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td></td>
|
|
<td></td><td></td><td></td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc">
|
|
|
|
<p>
|
|
Received when the topic is changed for the channel.<p>
|
|
<dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td valign="top"></td><td valign="top"><em>aTopic</em> </td><td>The new topic of the channel. </td></tr>
|
|
<tr><td valign="top"></td><td valign="top"><em>nick</em> </td><td>Nickname of the IRC client that changed the topic. </td></tr>
|
|
</table>
|
|
</dl>
|
|
|
|
</div>
|
|
</div><p>
|
|
<hr>The documentation for this class was generated from the following file:<ul>
|
|
<li><a class="el" href="_i_r_c_client_channel_delegate_8h-source.html">IRCClientChannelDelegate.h</a></ul>
|
|
</div>
|
|
<hr size="1"><address style="text-align: right;"><small>Generated on Sat Jan 10 18:10:37 2009 for IRCClient by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address>
|
|
</body>
|
|
</html>
|