This repository has been archived on 2024-03-02. You can view files and clone it, but cannot push or open issues or pull requests.
libircclient/cocoa/doc/html/interface_i_r_c_client_channel.html
2023-08-07 02:58:04 -06:00

474 lines
21 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: IRCClientChannel 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&nbsp;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&nbsp;List</span></a></li>
<li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>IRCClientChannel Class Reference</h1><!-- doxytag: class="IRCClientChannel" --><!-- doxytag: inherits="NSObject" -->Represents a connected IRC Channel.
<a href="#_details">More...</a>
<p>
<code>#import &lt;<a class="el" href="_i_r_c_client_channel_8h-source.html">IRCClientChannel.h</a>&gt;</code>
<p>
<div class="dynheader">
Inheritance diagram for IRCClientChannel:</div>
<div class="dynsection">
<p><center><img src="interface_i_r_c_client_channel.png" usemap="#IRCClientChannel_map" border="0" alt=""></center>
<map name="IRCClientChannel_map">
</map>
</div>
<p>
<a href="class_i_r_c_client_channel-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">(id)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_channel.html#01568915fb1763dbbe851598bf6111a3">initWithName:</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_channel.html#374315cc58c1e27ee74f15f6da4da699">part</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_channel.html#6a3081eee9d9f576a554e451f38a85af">invite:</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(void)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_channel.html#5a30badfcab9de2b95a9546758355850">setTopic:</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_channel.html#2a7b182090c69541c9b1d5919da842de">setMode:params:</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_channel.html#4c130a850d288754d0bb80a50be50b3c">message:</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_channel.html#3dce7913593cee47fff8f6d052139e84">action:</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_channel.html#d3ff98549b3bf39c581d2c5b62d6de8d">notice:</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_channel.html#a11844c7c48140a83464b5da453411db">kick:reason:</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int)&nbsp;</td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_channel.html#e48470def47fee0442f84d6cbb61805f">ctcpRequest:</a></td></tr>
<tr><td colspan="2"><br><h2>Properties</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">id&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_channel.html#a24a320a08bb515f3ef5862d7bb1e6b2">delegate</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">NSString *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_channel.html#fe81a99a24e3bc66fc5f05742fb52096">name</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">NSStringEncoding&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_channel.html#b2c7c8cea97e6f0dfd50f5ac2576a328">encoding</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="interface_i_r_c_client_session.html">IRCClientSession</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_channel.html#1edd5edd8ec30f8763a8ad703e0bf0b1">session</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">NSString *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_channel.html#eb5124389861d676b3332cca7c8dc000">topic</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">NSString *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_channel.html#b1d93e3a44e0f306b0bf9034c9d73ba3">modes</a></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">NSMutableArray *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_channel.html#d60403088ddc1434db87825e62c57d5c">names</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Represents a connected IRC Channel.
<p>
<a class="el" href="interface_i_r_c_client_channel.html" title="Represents a connected IRC Channel.">IRCClientChannel</a> objects are created by the <a class="el" href="interface_i_r_c_client_session.html" title="Represents a connected IRC Session.">IRCClientSession</a> object for a given session when the client joins an IRC channel. At that time you are expected to register event handlers for each of the delegate methods described in the <a class="el" href="protocol_i_r_c_client_channel_delegate-p.html">IRCClientChannelDelegate</a> interface. <hr><h2>Member Function Documentation</h2>
<a class="anchor" name="3dce7913593cee47fff8f6d052139e84"></a><!-- doxytag: member="IRCClientChannel::action:" ref="3dce7913593cee47fff8f6d052139e84" args="(NSString *action)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (int) action: </td>
<td></td>
<td class="paramtype">(NSString *)&nbsp;</td>
<td class="paramname"> <em>action</em> </td>
<td>&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sends a public CTCP ACTION to 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>action</em>&nbsp;</td><td>action to send to the channel. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="e48470def47fee0442f84d6cbb61805f"></a><!-- doxytag: member="IRCClientChannel::ctcpRequest:" ref="e48470def47fee0442f84d6cbb61805f" args="(NSString *request)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (int) ctcpRequest: </td>
<td></td>
<td class="paramtype">(NSString *)&nbsp;</td>
<td class="paramname"> <em>request</em> </td>
<td>&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sends a CTCP request to the channel.<p>
It is perfectly legal to send a CTCP request to an IRC channel, however many clients decline to respond to them, and often they are percieved as annoying.<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>request</em>&nbsp;</td><td>the string of the request, in CTCP format. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="01568915fb1763dbbe851598bf6111a3"></a><!-- doxytag: member="IRCClientChannel::initWithName:" ref="01568915fb1763dbbe851598bf6111a3" args="(NSString *aName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (id) initWithName: </td>
<td></td>
<td class="paramtype">(NSString *)&nbsp;</td>
<td class="paramname"> <em>aName</em> </td>
<td>&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
initWithName:<p>
Returns an initialised <a class="el" href="interface_i_r_c_client_channel.html" title="Represents a connected IRC Channel.">IRCClientChannel</a> with a given channel name. You are not expected to initialise your own <a class="el" href="interface_i_r_c_client_channel.html" title="Represents a connected IRC Channel.">IRCClientChannel</a> objects; if you wish to join a channel you should send a [<a class="el" href="interface_i_r_c_client_session.html" title="Represents a connected IRC Session.">IRCClientSession</a> join:key:] message to your <a class="el" href="interface_i_r_c_client_session.html" title="Represents a connected IRC Session.">IRCClientSession</a> object.<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>aName</em>&nbsp;</td><td>Name of the channel. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="6a3081eee9d9f576a554e451f38a85af"></a><!-- doxytag: member="IRCClientChannel::invite:" ref="6a3081eee9d9f576a554e451f38a85af" args="(NSString *nick)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (int) invite: </td>
<td></td>
<td class="paramtype">(NSString *)&nbsp;</td>
<td class="paramname"> <em>nick</em> </td>
<td>&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Invites another IRC client to 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>nick</em>&nbsp;</td><td>the nickname of the client to invite. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="a11844c7c48140a83464b5da453411db"></a><!-- doxytag: member="IRCClientChannel::kick:reason:" ref="a11844c7c48140a83464b5da453411db" args="(NSString *nick,[reason] NSString *reason)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (int) kick: </td>
<td></td>
<td class="paramtype">(NSString *)&nbsp;</td>
<td class="paramname"> <em>nick</em></td>
</tr>
<tr>
<td class="paramkey">reason:</td>
<td></td>
<td class="paramtype">(NSString *)&nbsp;</td>
<td class="paramname"> <em>reason</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Kicks someone 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>&nbsp;</td><td>the IRC client to kick from the channel. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>reason</em>&nbsp;</td><td>the message to give to the channel and the IRC client for the kick. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="4c130a850d288754d0bb80a50be50b3c"></a><!-- doxytag: member="IRCClientChannel::message:" ref="4c130a850d288754d0bb80a50be50b3c" args="(NSString *message)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (int) message: </td>
<td></td>
<td class="paramtype">(NSString *)&nbsp;</td>
<td class="paramname"> <em>message</em> </td>
<td>&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sends a public PRIVMSG to the channel. If you try to send more than can fit on an IRC buffer, it will be truncated.<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>&nbsp;</td><td>the message to send to the channel. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="d3ff98549b3bf39c581d2c5b62d6de8d"></a><!-- doxytag: member="IRCClientChannel::notice:" ref="d3ff98549b3bf39c581d2c5b62d6de8d" args="(NSString *notice)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (int) notice: </td>
<td></td>
<td class="paramtype">(NSString *)&nbsp;</td>
<td class="paramname"> <em>notice</em> </td>
<td>&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sends a public NOTICE to 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>notice</em>&nbsp;</td><td>message to send to the channel. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="374315cc58c1e27ee74f15f6da4da699"></a><!-- doxytag: member="IRCClientChannel::part" ref="374315cc58c1e27ee74f15f6da4da699" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (int) part </td>
<td></td>
<td class="paramname"> </td>
<td>&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parts the channel.
</div>
</div><p>
<a class="anchor" name="2a7b182090c69541c9b1d5919da842de"></a><!-- doxytag: member="IRCClientChannel::setMode:params:" ref="2a7b182090c69541c9b1d5919da842de" args="(NSString *mode,[params] NSString *params)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (int) setMode: </td>
<td></td>
<td class="paramtype">(NSString *)&nbsp;</td>
<td class="paramname"> <em>mode</em></td>
</tr>
<tr>
<td class="paramkey">params:</td>
<td></td>
<td class="paramtype">(NSString *)&nbsp;</td>
<td class="paramname"> <em>params</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td></td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the mode of the channel.<p>
Note that not all users on a channel have permission to change the mode; if you fail to set the mode, then you will not see an onMode event on the <a class="el" href="protocol_i_r_c_client_channel_delegate-p.html">IRCClientChannelDelegate</a>.<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>&nbsp;</td><td>the mode to set the channel to </td></tr>
<tr><td valign="top"></td><td valign="top"><em>params</em>&nbsp;</td><td>paramaters for the mode, if it requires parameters. </td></tr>
</table>
</dl>
</div>
</div><p>
<a class="anchor" name="5a30badfcab9de2b95a9546758355850"></a><!-- doxytag: member="IRCClientChannel::setTopic:" ref="5a30badfcab9de2b95a9546758355850" args="(NSString *aTopic)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (void) setTopic: </td>
<td></td>
<td class="paramtype">(NSString *)&nbsp;</td>
<td class="paramname"> <em>aTopic</em> </td>
<td>&nbsp;</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Sets the topic of the channel.<p>
Note that not all users on a channel have permission to change the topic; if you fail to set the topic, then you will not see an onTopic event on the <a class="el" href="protocol_i_r_c_client_channel_delegate-p.html">IRCClientChannelDelegate</a>.<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>&nbsp;</td><td>the topic the client wishes to set for the channel. </td></tr>
</table>
</dl>
</div>
</div><p>
<hr><h2>Property Documentation</h2>
<a class="anchor" name="a24a320a08bb515f3ef5862d7bb1e6b2"></a><!-- doxytag: member="IRCClientChannel::delegate" ref="a24a320a08bb515f3ef5862d7bb1e6b2" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (id) delegate<code> [read, write, assign]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Delegate to send events to
</div>
</div><p>
<a class="anchor" name="b2c7c8cea97e6f0dfd50f5ac2576a328"></a><!-- doxytag: member="IRCClientChannel::encoding" ref="b2c7c8cea97e6f0dfd50f5ac2576a328" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (NSStringEncoding) encoding<code> [read, write, assign]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Encoding used by this channel
</div>
</div><p>
<a class="anchor" name="b1d93e3a44e0f306b0bf9034c9d73ba3"></a><!-- doxytag: member="IRCClientChannel::modes" ref="b1d93e3a44e0f306b0bf9034c9d73ba3" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (NSString *) modes<code> [read, write, copy]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Mode of the channel
</div>
</div><p>
<a class="anchor" name="fe81a99a24e3bc66fc5f05742fb52096"></a><!-- doxytag: member="IRCClientChannel::name" ref="fe81a99a24e3bc66fc5f05742fb52096" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (NSString *) name<code> [read, write, copy]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Name of the channel
</div>
</div><p>
<a class="anchor" name="d60403088ddc1434db87825e62c57d5c"></a><!-- doxytag: member="IRCClientChannel::names" ref="d60403088ddc1434db87825e62c57d5c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (NSMutableArray *) names<code> [read, assign]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
An array of nicknames stored as NSStrings that list the connected users for the channel
</div>
</div><p>
<a class="anchor" name="1edd5edd8ec30f8763a8ad703e0bf0b1"></a><!-- doxytag: member="IRCClientChannel::session" ref="1edd5edd8ec30f8763a8ad703e0bf0b1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (<a class="el" href="interface_i_r_c_client_session.html">IRCClientSession</a> *) session<code> [read, write, assign]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Associated <a class="el" href="interface_i_r_c_client_session.html" title="Represents a connected IRC Session.">IRCClientSession</a> object
</div>
</div><p>
<a class="anchor" name="eb5124389861d676b3332cca7c8dc000"></a><!-- doxytag: member="IRCClientChannel::topic" ref="eb5124389861d676b3332cca7c8dc000" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (NSString *) topic<code> [read, write, copy]</code> </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Topic of the channel
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_i_r_c_client_channel_8h-source.html">IRCClientChannel.h</a><li>IRCClientChannel.m</ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Sat Jan 10 18:10:37 2009 for IRCClient by&nbsp;
<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>