| 1 |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> |
| 2 |
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> |
| 3 |
<title>IRCClient: IRCClientChannel Class Reference</title> |
| 4 |
<link href="doxygen.css" rel="stylesheet" type="text/css"> |
| 5 |
<link href="tabs.css" rel="stylesheet" type="text/css"> |
| 6 |
</head><body> |
| 7 |
<!-- Generated by Doxygen 1.5.7.1 --> |
| 8 |
<div class="navigation" id="top"> |
| 9 |
<div class="tabs"> |
| 10 |
<ul> |
| 11 |
<li><a href="index.html"><span>Main Page</span></a></li> |
| 12 |
<li class="current"><a href="annotated.html"><span>Classes</span></a></li> |
| 13 |
<li><a href="files.html"><span>Files</span></a></li> |
| 14 |
</ul> |
| 15 |
</div> |
| 16 |
<div class="tabs"> |
| 17 |
<ul> |
| 18 |
<li><a href="annotated.html"><span>Class List</span></a></li> |
| 19 |
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li> |
| 20 |
<li><a href="functions.html"><span>Class Members</span></a></li> |
| 21 |
</ul> |
| 22 |
</div> |
| 23 |
</div> |
| 24 |
<div class="contents"> |
| 25 |
<h1>IRCClientChannel Class Reference</h1><!-- doxytag: class="IRCClientChannel" --><!-- doxytag: inherits="NSObject" -->Represents a connected IRC Channel. |
| 26 |
<a href="#_details">More...</a> |
| 27 |
<p> |
| 28 |
<code>#import <<a class="el" href="_i_r_c_client_channel_8h-source.html">IRCClientChannel.h</a>></code> |
| 29 |
<p> |
| 30 |
<div class="dynheader"> |
| 31 |
Inheritance diagram for IRCClientChannel:</div> |
| 32 |
<div class="dynsection"> |
| 33 |
|
| 34 |
<p><center><img src="interface_i_r_c_client_channel.png" usemap="#IRCClientChannel_map" border="0" alt=""></center> |
| 35 |
<map name="IRCClientChannel_map"> |
| 36 |
</map> |
| 37 |
</div> |
| 38 |
|
| 39 |
<p> |
| 40 |
<a href="class_i_r_c_client_channel-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0"> |
| 41 |
<tr><td></td></tr> |
| 42 |
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr> |
| 43 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">(id) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_channel.html#01568915fb1763dbbe851598bf6111a3">initWithName:</a></td></tr> |
| 44 |
|
| 45 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_channel.html#374315cc58c1e27ee74f15f6da4da699">part</a></td></tr> |
| 46 |
|
| 47 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_channel.html#6a3081eee9d9f576a554e451f38a85af">invite:</a></td></tr> |
| 48 |
|
| 49 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">(void) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_channel.html#5a30badfcab9de2b95a9546758355850">setTopic:</a></td></tr> |
| 50 |
|
| 51 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_channel.html#2a7b182090c69541c9b1d5919da842de">setMode:params:</a></td></tr> |
| 52 |
|
| 53 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_channel.html#4c130a850d288754d0bb80a50be50b3c">message:</a></td></tr> |
| 54 |
|
| 55 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_channel.html#3dce7913593cee47fff8f6d052139e84">action:</a></td></tr> |
| 56 |
|
| 57 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_channel.html#d3ff98549b3bf39c581d2c5b62d6de8d">notice:</a></td></tr> |
| 58 |
|
| 59 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_channel.html#a11844c7c48140a83464b5da453411db">kick:reason:</a></td></tr> |
| 60 |
|
| 61 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">(int) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_i_r_c_client_channel.html#e48470def47fee0442f84d6cbb61805f">ctcpRequest:</a></td></tr> |
| 62 |
|
| 63 |
<tr><td colspan="2"><br><h2>Properties</h2></td></tr> |
| 64 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">id </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_channel.html#a24a320a08bb515f3ef5862d7bb1e6b2">delegate</a></td></tr> |
| 65 |
|
| 66 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">NSString * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_channel.html#fe81a99a24e3bc66fc5f05742fb52096">name</a></td></tr> |
| 67 |
|
| 68 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">NSStringEncoding </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_channel.html#b2c7c8cea97e6f0dfd50f5ac2576a328">encoding</a></td></tr> |
| 69 |
|
| 70 |
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="interface_i_r_c_client_session.html">IRCClientSession</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_channel.html#1edd5edd8ec30f8763a8ad703e0bf0b1">session</a></td></tr> |
| 71 |
|
| 72 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">NSString * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_channel.html#eb5124389861d676b3332cca7c8dc000">topic</a></td></tr> |
| 73 |
|
| 74 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">NSString * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_channel.html#b1d93e3a44e0f306b0bf9034c9d73ba3">modes</a></td></tr> |
| 75 |
|
| 76 |
<tr><td class="memItemLeft" nowrap align="right" valign="top">NSMutableArray * </td><td class="memItemRight" valign="bottom"><a class="el" href="interface_i_r_c_client_channel.html#d60403088ddc1434db87825e62c57d5c">names</a></td></tr> |
| 77 |
|
| 78 |
</table> |
| 79 |
<hr><a name="_details"></a><h2>Detailed Description</h2> |
| 80 |
Represents a connected IRC Channel. |
| 81 |
<p> |
| 82 |
<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> |
| 83 |
<a class="anchor" name="3dce7913593cee47fff8f6d052139e84"></a><!-- doxytag: member="IRCClientChannel::action:" ref="3dce7913593cee47fff8f6d052139e84" args="(NSString *action)" --> |
| 84 |
<div class="memitem"> |
| 85 |
<div class="memproto"> |
| 86 |
<table class="memname"> |
| 87 |
<tr> |
| 88 |
<td class="memname">- (int) action: </td> |
| 89 |
<td></td> |
| 90 |
<td class="paramtype">(NSString *) </td> |
| 91 |
<td class="paramname"> <em>action</em> </td> |
| 92 |
<td> </td> |
| 93 |
<td></td> |
| 94 |
</tr> |
| 95 |
</table> |
| 96 |
</div> |
| 97 |
<div class="memdoc"> |
| 98 |
|
| 99 |
<p> |
| 100 |
Sends a public CTCP ACTION to the channel.<p> |
| 101 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 102 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 103 |
<tr><td valign="top"></td><td valign="top"><em>action</em> </td><td>action to send to the channel. </td></tr> |
| 104 |
</table> |
| 105 |
</dl> |
| 106 |
|
| 107 |
</div> |
| 108 |
</div><p> |
| 109 |
<a class="anchor" name="e48470def47fee0442f84d6cbb61805f"></a><!-- doxytag: member="IRCClientChannel::ctcpRequest:" ref="e48470def47fee0442f84d6cbb61805f" args="(NSString *request)" --> |
| 110 |
<div class="memitem"> |
| 111 |
<div class="memproto"> |
| 112 |
<table class="memname"> |
| 113 |
<tr> |
| 114 |
<td class="memname">- (int) ctcpRequest: </td> |
| 115 |
<td></td> |
| 116 |
<td class="paramtype">(NSString *) </td> |
| 117 |
<td class="paramname"> <em>request</em> </td> |
| 118 |
<td> </td> |
| 119 |
<td></td> |
| 120 |
</tr> |
| 121 |
</table> |
| 122 |
</div> |
| 123 |
<div class="memdoc"> |
| 124 |
|
| 125 |
<p> |
| 126 |
Sends a CTCP request to the channel.<p> |
| 127 |
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> |
| 128 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 129 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 130 |
<tr><td valign="top"></td><td valign="top"><em>request</em> </td><td>the string of the request, in CTCP format. </td></tr> |
| 131 |
</table> |
| 132 |
</dl> |
| 133 |
|
| 134 |
</div> |
| 135 |
</div><p> |
| 136 |
<a class="anchor" name="01568915fb1763dbbe851598bf6111a3"></a><!-- doxytag: member="IRCClientChannel::initWithName:" ref="01568915fb1763dbbe851598bf6111a3" args="(NSString *aName)" --> |
| 137 |
<div class="memitem"> |
| 138 |
<div class="memproto"> |
| 139 |
<table class="memname"> |
| 140 |
<tr> |
| 141 |
<td class="memname">- (id) initWithName: </td> |
| 142 |
<td></td> |
| 143 |
<td class="paramtype">(NSString *) </td> |
| 144 |
<td class="paramname"> <em>aName</em> </td> |
| 145 |
<td> </td> |
| 146 |
<td></td> |
| 147 |
</tr> |
| 148 |
</table> |
| 149 |
</div> |
| 150 |
<div class="memdoc"> |
| 151 |
|
| 152 |
<p> |
| 153 |
initWithName:<p> |
| 154 |
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> |
| 155 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 156 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 157 |
<tr><td valign="top"></td><td valign="top"><em>aName</em> </td><td>Name of the channel. </td></tr> |
| 158 |
</table> |
| 159 |
</dl> |
| 160 |
|
| 161 |
</div> |
| 162 |
</div><p> |
| 163 |
<a class="anchor" name="6a3081eee9d9f576a554e451f38a85af"></a><!-- doxytag: member="IRCClientChannel::invite:" ref="6a3081eee9d9f576a554e451f38a85af" args="(NSString *nick)" --> |
| 164 |
<div class="memitem"> |
| 165 |
<div class="memproto"> |
| 166 |
<table class="memname"> |
| 167 |
<tr> |
| 168 |
<td class="memname">- (int) invite: </td> |
| 169 |
<td></td> |
| 170 |
<td class="paramtype">(NSString *) </td> |
| 171 |
<td class="paramname"> <em>nick</em> </td> |
| 172 |
<td> </td> |
| 173 |
<td></td> |
| 174 |
</tr> |
| 175 |
</table> |
| 176 |
</div> |
| 177 |
<div class="memdoc"> |
| 178 |
|
| 179 |
<p> |
| 180 |
Invites another IRC client to the channel.<p> |
| 181 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 182 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 183 |
<tr><td valign="top"></td><td valign="top"><em>nick</em> </td><td>the nickname of the client to invite. </td></tr> |
| 184 |
</table> |
| 185 |
</dl> |
| 186 |
|
| 187 |
</div> |
| 188 |
</div><p> |
| 189 |
<a class="anchor" name="a11844c7c48140a83464b5da453411db"></a><!-- doxytag: member="IRCClientChannel::kick:reason:" ref="a11844c7c48140a83464b5da453411db" args="(NSString *nick,[reason] NSString *reason)" --> |
| 190 |
<div class="memitem"> |
| 191 |
<div class="memproto"> |
| 192 |
<table class="memname"> |
| 193 |
<tr> |
| 194 |
<td class="memname">- (int) kick: </td> |
| 195 |
<td></td> |
| 196 |
<td class="paramtype">(NSString *) </td> |
| 197 |
<td class="paramname"> <em>nick</em></td> |
| 198 |
</tr> |
| 199 |
<tr> |
| 200 |
<td class="paramkey">reason:</td> |
| 201 |
<td></td> |
| 202 |
<td class="paramtype">(NSString *) </td> |
| 203 |
<td class="paramname"> <em>reason</em></td><td> </td> |
| 204 |
</tr> |
| 205 |
<tr> |
| 206 |
<td></td> |
| 207 |
<td></td> |
| 208 |
<td></td><td></td><td></td> |
| 209 |
</tr> |
| 210 |
</table> |
| 211 |
</div> |
| 212 |
<div class="memdoc"> |
| 213 |
|
| 214 |
<p> |
| 215 |
Kicks someone from a channel.<p> |
| 216 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 217 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 218 |
<tr><td valign="top"></td><td valign="top"><em>nick</em> </td><td>the IRC client to kick from the channel. </td></tr> |
| 219 |
<tr><td valign="top"></td><td valign="top"><em>reason</em> </td><td>the message to give to the channel and the IRC client for the kick. </td></tr> |
| 220 |
</table> |
| 221 |
</dl> |
| 222 |
|
| 223 |
</div> |
| 224 |
</div><p> |
| 225 |
<a class="anchor" name="4c130a850d288754d0bb80a50be50b3c"></a><!-- doxytag: member="IRCClientChannel::message:" ref="4c130a850d288754d0bb80a50be50b3c" args="(NSString *message)" --> |
| 226 |
<div class="memitem"> |
| 227 |
<div class="memproto"> |
| 228 |
<table class="memname"> |
| 229 |
<tr> |
| 230 |
<td class="memname">- (int) message: </td> |
| 231 |
<td></td> |
| 232 |
<td class="paramtype">(NSString *) </td> |
| 233 |
<td class="paramname"> <em>message</em> </td> |
| 234 |
<td> </td> |
| 235 |
<td></td> |
| 236 |
</tr> |
| 237 |
</table> |
| 238 |
</div> |
| 239 |
<div class="memdoc"> |
| 240 |
|
| 241 |
<p> |
| 242 |
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> |
| 243 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 244 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 245 |
<tr><td valign="top"></td><td valign="top"><em>message</em> </td><td>the message to send to the channel. </td></tr> |
| 246 |
</table> |
| 247 |
</dl> |
| 248 |
|
| 249 |
</div> |
| 250 |
</div><p> |
| 251 |
<a class="anchor" name="d3ff98549b3bf39c581d2c5b62d6de8d"></a><!-- doxytag: member="IRCClientChannel::notice:" ref="d3ff98549b3bf39c581d2c5b62d6de8d" args="(NSString *notice)" --> |
| 252 |
<div class="memitem"> |
| 253 |
<div class="memproto"> |
| 254 |
<table class="memname"> |
| 255 |
<tr> |
| 256 |
<td class="memname">- (int) notice: </td> |
| 257 |
<td></td> |
| 258 |
<td class="paramtype">(NSString *) </td> |
| 259 |
<td class="paramname"> <em>notice</em> </td> |
| 260 |
<td> </td> |
| 261 |
<td></td> |
| 262 |
</tr> |
| 263 |
</table> |
| 264 |
</div> |
| 265 |
<div class="memdoc"> |
| 266 |
|
| 267 |
<p> |
| 268 |
Sends a public NOTICE to the channel.<p> |
| 269 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 270 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 271 |
<tr><td valign="top"></td><td valign="top"><em>notice</em> </td><td>message to send to the channel. </td></tr> |
| 272 |
</table> |
| 273 |
</dl> |
| 274 |
|
| 275 |
</div> |
| 276 |
</div><p> |
| 277 |
<a class="anchor" name="374315cc58c1e27ee74f15f6da4da699"></a><!-- doxytag: member="IRCClientChannel::part" ref="374315cc58c1e27ee74f15f6da4da699" args="()" --> |
| 278 |
<div class="memitem"> |
| 279 |
<div class="memproto"> |
| 280 |
<table class="memname"> |
| 281 |
<tr> |
| 282 |
<td class="memname">- (int) part </td> |
| 283 |
<td></td> |
| 284 |
<td class="paramname"> </td> |
| 285 |
<td> </td> |
| 286 |
<td></td> |
| 287 |
</tr> |
| 288 |
</table> |
| 289 |
</div> |
| 290 |
<div class="memdoc"> |
| 291 |
|
| 292 |
<p> |
| 293 |
Parts the channel. |
| 294 |
</div> |
| 295 |
</div><p> |
| 296 |
<a class="anchor" name="2a7b182090c69541c9b1d5919da842de"></a><!-- doxytag: member="IRCClientChannel::setMode:params:" ref="2a7b182090c69541c9b1d5919da842de" args="(NSString *mode,[params] NSString *params)" --> |
| 297 |
<div class="memitem"> |
| 298 |
<div class="memproto"> |
| 299 |
<table class="memname"> |
| 300 |
<tr> |
| 301 |
<td class="memname">- (int) setMode: </td> |
| 302 |
<td></td> |
| 303 |
<td class="paramtype">(NSString *) </td> |
| 304 |
<td class="paramname"> <em>mode</em></td> |
| 305 |
</tr> |
| 306 |
<tr> |
| 307 |
<td class="paramkey">params:</td> |
| 308 |
<td></td> |
| 309 |
<td class="paramtype">(NSString *) </td> |
| 310 |
<td class="paramname"> <em>params</em></td><td> </td> |
| 311 |
</tr> |
| 312 |
<tr> |
| 313 |
<td></td> |
| 314 |
<td></td> |
| 315 |
<td></td><td></td><td></td> |
| 316 |
</tr> |
| 317 |
</table> |
| 318 |
</div> |
| 319 |
<div class="memdoc"> |
| 320 |
|
| 321 |
<p> |
| 322 |
Sets the mode of the channel.<p> |
| 323 |
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> |
| 324 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 325 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 326 |
<tr><td valign="top"></td><td valign="top"><em>mode</em> </td><td>the mode to set the channel to </td></tr> |
| 327 |
<tr><td valign="top"></td><td valign="top"><em>params</em> </td><td>paramaters for the mode, if it requires parameters. </td></tr> |
| 328 |
</table> |
| 329 |
</dl> |
| 330 |
|
| 331 |
</div> |
| 332 |
</div><p> |
| 333 |
<a class="anchor" name="5a30badfcab9de2b95a9546758355850"></a><!-- doxytag: member="IRCClientChannel::setTopic:" ref="5a30badfcab9de2b95a9546758355850" args="(NSString *aTopic)" --> |
| 334 |
<div class="memitem"> |
| 335 |
<div class="memproto"> |
| 336 |
<table class="memname"> |
| 337 |
<tr> |
| 338 |
<td class="memname">- (void) setTopic: </td> |
| 339 |
<td></td> |
| 340 |
<td class="paramtype">(NSString *) </td> |
| 341 |
<td class="paramname"> <em>aTopic</em> </td> |
| 342 |
<td> </td> |
| 343 |
<td></td> |
| 344 |
</tr> |
| 345 |
</table> |
| 346 |
</div> |
| 347 |
<div class="memdoc"> |
| 348 |
|
| 349 |
<p> |
| 350 |
Sets the topic of the channel.<p> |
| 351 |
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> |
| 352 |
<dl compact><dt><b>Parameters:</b></dt><dd> |
| 353 |
<table border="0" cellspacing="2" cellpadding="0"> |
| 354 |
<tr><td valign="top"></td><td valign="top"><em>aTopic</em> </td><td>the topic the client wishes to set for the channel. </td></tr> |
| 355 |
</table> |
| 356 |
</dl> |
| 357 |
|
| 358 |
</div> |
| 359 |
</div><p> |
| 360 |
<hr><h2>Property Documentation</h2> |
| 361 |
<a class="anchor" name="a24a320a08bb515f3ef5862d7bb1e6b2"></a><!-- doxytag: member="IRCClientChannel::delegate" ref="a24a320a08bb515f3ef5862d7bb1e6b2" args="" --> |
| 362 |
<div class="memitem"> |
| 363 |
<div class="memproto"> |
| 364 |
<table class="memname"> |
| 365 |
<tr> |
| 366 |
<td class="memname">- (id) delegate<code> [read, write, assign]</code> </td> |
| 367 |
</tr> |
| 368 |
</table> |
| 369 |
</div> |
| 370 |
<div class="memdoc"> |
| 371 |
|
| 372 |
<p> |
| 373 |
Delegate to send events to |
| 374 |
</div> |
| 375 |
</div><p> |
| 376 |
<a class="anchor" name="b2c7c8cea97e6f0dfd50f5ac2576a328"></a><!-- doxytag: member="IRCClientChannel::encoding" ref="b2c7c8cea97e6f0dfd50f5ac2576a328" args="" --> |
| 377 |
<div class="memitem"> |
| 378 |
<div class="memproto"> |
| 379 |
<table class="memname"> |
| 380 |
<tr> |
| 381 |
<td class="memname">- (NSStringEncoding) encoding<code> [read, write, assign]</code> </td> |
| 382 |
</tr> |
| 383 |
</table> |
| 384 |
</div> |
| 385 |
<div class="memdoc"> |
| 386 |
|
| 387 |
<p> |
| 388 |
Encoding used by this channel |
| 389 |
</div> |
| 390 |
</div><p> |
| 391 |
<a class="anchor" name="b1d93e3a44e0f306b0bf9034c9d73ba3"></a><!-- doxytag: member="IRCClientChannel::modes" ref="b1d93e3a44e0f306b0bf9034c9d73ba3" args="" --> |
| 392 |
<div class="memitem"> |
| 393 |
<div class="memproto"> |
| 394 |
<table class="memname"> |
| 395 |
<tr> |
| 396 |
<td class="memname">- (NSString *) modes<code> [read, write, copy]</code> </td> |
| 397 |
</tr> |
| 398 |
</table> |
| 399 |
</div> |
| 400 |
<div class="memdoc"> |
| 401 |
|
| 402 |
<p> |
| 403 |
Mode of the channel |
| 404 |
</div> |
| 405 |
</div><p> |
| 406 |
<a class="anchor" name="fe81a99a24e3bc66fc5f05742fb52096"></a><!-- doxytag: member="IRCClientChannel::name" ref="fe81a99a24e3bc66fc5f05742fb52096" args="" --> |
| 407 |
<div class="memitem"> |
| 408 |
<div class="memproto"> |
| 409 |
<table class="memname"> |
| 410 |
<tr> |
| 411 |
<td class="memname">- (NSString *) name<code> [read, write, copy]</code> </td> |
| 412 |
</tr> |
| 413 |
</table> |
| 414 |
</div> |
| 415 |
<div class="memdoc"> |
| 416 |
|
| 417 |
<p> |
| 418 |
Name of the channel |
| 419 |
</div> |
| 420 |
</div><p> |
| 421 |
<a class="anchor" name="d60403088ddc1434db87825e62c57d5c"></a><!-- doxytag: member="IRCClientChannel::names" ref="d60403088ddc1434db87825e62c57d5c" args="" --> |
| 422 |
<div class="memitem"> |
| 423 |
<div class="memproto"> |
| 424 |
<table class="memname"> |
| 425 |
<tr> |
| 426 |
<td class="memname">- (NSMutableArray *) names<code> [read, assign]</code> </td> |
| 427 |
</tr> |
| 428 |
</table> |
| 429 |
</div> |
| 430 |
<div class="memdoc"> |
| 431 |
|
| 432 |
<p> |
| 433 |
An array of nicknames stored as NSStrings that list the connected users for the channel |
| 434 |
</div> |
| 435 |
</div><p> |
| 436 |
<a class="anchor" name="1edd5edd8ec30f8763a8ad703e0bf0b1"></a><!-- doxytag: member="IRCClientChannel::session" ref="1edd5edd8ec30f8763a8ad703e0bf0b1" args="" --> |
| 437 |
<div class="memitem"> |
| 438 |
<div class="memproto"> |
| 439 |
<table class="memname"> |
| 440 |
<tr> |
| 441 |
<td class="memname">- (<a class="el" href="interface_i_r_c_client_session.html">IRCClientSession</a> *) session<code> [read, write, assign]</code> </td> |
| 442 |
</tr> |
| 443 |
</table> |
| 444 |
</div> |
| 445 |
<div class="memdoc"> |
| 446 |
|
| 447 |
<p> |
| 448 |
Associated <a class="el" href="interface_i_r_c_client_session.html" title="Represents a connected IRC Session.">IRCClientSession</a> object |
| 449 |
</div> |
| 450 |
</div><p> |
| 451 |
<a class="anchor" name="eb5124389861d676b3332cca7c8dc000"></a><!-- doxytag: member="IRCClientChannel::topic" ref="eb5124389861d676b3332cca7c8dc000" args="" --> |
| 452 |
<div class="memitem"> |
| 453 |
<div class="memproto"> |
| 454 |
<table class="memname"> |
| 455 |
<tr> |
| 456 |
<td class="memname">- (NSString *) topic<code> [read, write, copy]</code> </td> |
| 457 |
</tr> |
| 458 |
</table> |
| 459 |
</div> |
| 460 |
<div class="memdoc"> |
| 461 |
|
| 462 |
<p> |
| 463 |
Topic of the channel |
| 464 |
</div> |
| 465 |
</div><p> |
| 466 |
<hr>The documentation for this class was generated from the following files:<ul> |
| 467 |
<li><a class="el" href="_i_r_c_client_channel_8h-source.html">IRCClientChannel.h</a><li>IRCClientChannel.m</ul> |
| 468 |
</div> |
| 469 |
<hr size="1"><address style="text-align: right;"><small>Generated on Sat Jan 10 18:10:37 2009 for IRCClient by |
| 470 |
<a href="http://www.doxygen.org/index.html"> |
| 471 |
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.7.1 </small></address> |
| 472 |
</body> |
| 473 |
</html> |