1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>MumbleKit: MKChannel Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">MumbleKit
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.2 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<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>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</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>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Functions</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Instance Methods</a> |
<a href="class_m_k_channel-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">MKChannel Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#import <<a class="el" href="_m_k_channel_8h_source.html">MumbleKit/MKChannel.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for MKChannel:</div>
<div class="dyncontent">
<div class="center">
<img src="interface_m_k_channel.png" usemap="#MKChannel_map" alt=""/>
<map id="MKChannel_map" name="MKChannel_map">
</map>
</div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Instance Methods</h2></td></tr>
<tr class="memitem:a9787211d4077d2628755aa93b135628b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9787211d4077d2628755aa93b135628b"></a>
(NSUInteger) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_channel.html#a9787211d4077d2628755aa93b135628b">channelId</a></td></tr>
<tr class="memdesc:a9787211d4077d2628755aa93b135628b"><td class="mdescLeft"> </td><td class="mdescRight">Returns the channel's channel ID. <br/></td></tr>
<tr class="separator:a9787211d4077d2628755aa93b135628b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7e6931ce1016eb67913f7d2ed56c9fdf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7e6931ce1016eb67913f7d2ed56c9fdf"></a>
(NSString *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_channel.html#a7e6931ce1016eb67913f7d2ed56c9fdf">channelName</a></td></tr>
<tr class="memdesc:a7e6931ce1016eb67913f7d2ed56c9fdf"><td class="mdescLeft"> </td><td class="mdescRight">Returns the channel's name. <br/></td></tr>
<tr class="separator:a7e6931ce1016eb67913f7d2ed56c9fdf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a58f223c1a05d9f19a05e2041243d25d5"><td class="memItemLeft" align="right" valign="top">(BOOL) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_channel.html#a58f223c1a05d9f19a05e2041243d25d5">isTemporary</a></td></tr>
<tr class="separator:a58f223c1a05d9f19a05e2041243d25d5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa602aac2f37090b36da147c04307834d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa602aac2f37090b36da147c04307834d"></a>
(NSInteger) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_channel.html#aa602aac2f37090b36da147c04307834d">position</a></td></tr>
<tr class="memdesc:aa602aac2f37090b36da147c04307834d"><td class="mdescLeft"> </td><td class="mdescRight">Returns the position of the channel. <br/></td></tr>
<tr class="separator:aa602aac2f37090b36da147c04307834d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4995958e3d975e5745a49673b065e018"><td class="memItemLeft" align="right" valign="top">(<a class="el" href="interface_m_k_channel.html">MKChannel</a> *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_channel.html#a4995958e3d975e5745a49673b065e018">parent</a></td></tr>
<tr class="separator:a4995958e3d975e5745a49673b065e018"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad0895dda1506884e72cf9adf8c4cb80a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad0895dda1506884e72cf9adf8c4cb80a"></a>
(NSArray *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_channel.html#ad0895dda1506884e72cf9adf8c4cb80a">channels</a></td></tr>
<tr class="memdesc:ad0895dda1506884e72cf9adf8c4cb80a"><td class="mdescLeft"> </td><td class="mdescRight">Returns an NSArray of the channel's subchannels represented as MKChannels. <br/></td></tr>
<tr class="separator:ad0895dda1506884e72cf9adf8c4cb80a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a77133cb0a2e9ebd372aefdb2c85f9e7c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a77133cb0a2e9ebd372aefdb2c85f9e7c"></a>
(NSArray *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_channel.html#a77133cb0a2e9ebd372aefdb2c85f9e7c">users</a></td></tr>
<tr class="memdesc:a77133cb0a2e9ebd372aefdb2c85f9e7c"><td class="mdescLeft"> </td><td class="mdescRight">Returns an NSArray of all users in the channel. The users are represented as MKUsers. <br/></td></tr>
<tr class="separator:a77133cb0a2e9ebd372aefdb2c85f9e7c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adefcbc8c0ad68e171f571e064a4c5c01"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adefcbc8c0ad68e171f571e064a4c5c01"></a>
(NSArray *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_channel.html#adefcbc8c0ad68e171f571e064a4c5c01">linkedChannels</a></td></tr>
<tr class="memdesc:adefcbc8c0ad68e171f571e064a4c5c01"><td class="mdescLeft"> </td><td class="mdescRight">Returns an NSArray of all channels linked to this channel. <br/></td></tr>
<tr class="separator:adefcbc8c0ad68e171f571e064a4c5c01"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a23763b16ff29a2abf4e39a529dc132cf"><td class="memItemLeft" align="right" valign="top">(BOOL) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_channel.html#a23763b16ff29a2abf4e39a529dc132cf">isLinkedToChannel:</a></td></tr>
<tr class="separator:a23763b16ff29a2abf4e39a529dc132cf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afc3778d516c852315f429e7b73069215"><td class="memItemLeft" align="right" valign="top">(NSData *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_channel.html#afc3778d516c852315f429e7b73069215">channelDescriptionHash</a></td></tr>
<tr class="separator:afc3778d516c852315f429e7b73069215"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abaf05c5e686cc5647f6b9463a18eb2c0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abaf05c5e686cc5647f6b9463a18eb2c0"></a>
(NSString *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_channel.html#abaf05c5e686cc5647f6b9463a18eb2c0">channelDescription</a></td></tr>
<tr class="memdesc:abaf05c5e686cc5647f6b9463a18eb2c0"><td class="mdescLeft"> </td><td class="mdescRight">Returns the channel's description. <br/></td></tr>
<tr class="separator:abaf05c5e686cc5647f6b9463a18eb2c0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="interface_m_k_channel.html">MKChannel</a> represents a channel on a Mumble server. <a class="el" href="interface_m_k_channel.html">MKChannel</a> objects are owned by their respective <a class="el" href="interface_m_k_server_model.html">MKServerModel</a> instances.</p>
<p>The object's <a class="el" href="interface_m_k_server_model.html">MKServerModel</a> may change properties of the channel at any time, but all changes are serialized to the main thread.</p>
<p>Generally, as a consumer of this API, most accesses to <a class="el" href="interface_m_k_channel.html">MKChannel</a> happen in response to <a class="el" href="protocol_m_k_server_model_delegate-p.html">MKServerModelDelegate</a> callbacks, and all calls to delegate methods of <a class="el" href="interface_m_k_server_model.html">MKServerModel</a> are ensured to happen on the same thread that modifies MKChannle objects.</p>
<p>Thus, if all inspection of the <a class="el" href="interface_m_k_channel.html">MKChannel</a>'s properties happen in response to <a class="el" href="protocol_m_k_server_model_delegate-p.html">MKServerModelDelegate</a> callbacks, everything should be OK. </p>
</div><h2 class="groupheader">Method Documentation</h2>
<a class="anchor" id="afc3778d516c852315f429e7b73069215"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (NSData *) channelDescriptionHash </td>
<td></td>
<td class="paramname"></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a channel's description hash. (On most server implementations, this is a SHA1 digest). </p>
</div>
</div>
<a class="anchor" id="a23763b16ff29a2abf4e39a529dc132cf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (BOOL) isLinkedToChannel: </td>
<td></td>
<td class="paramtype">(<a class="el" href="interface_m_k_channel.html">MKChannel</a> *) </td>
<td class="paramname"><em>channel</em></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether a given channel is linked to the receiving channel.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">channel</td><td>The channel whose link status should be checked.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns YES if the receiving channel is linked to channel. Otherwise, returns NO. </dd></dl>
</div>
</div>
<a class="anchor" id="a58f223c1a05d9f19a05e2041243d25d5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (BOOL) isTemporary </td>
<td></td>
<td class="paramname"></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns whether or not the channel is temporary.</p>
<dl class="section return"><dt>Returns</dt><dd>Returns YES if the channel is temporary. Returns NO if the channel is permanent. </dd></dl>
</div>
</div>
<a class="anchor" id="a4995958e3d975e5745a49673b065e018"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (<a class="el" href="interface_m_k_channel.html">MKChannel</a> *) parent </td>
<td></td>
<td class="paramname"></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the channel's parent.</p>
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="interface_m_k_channel.html">MKChannel</a> object representing the channel's parent. Returns nil if the current channel is the root channel. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>/Users/mkrautz/Documents/mumble-iphoneos/MumbleKit/src/MumbleKit/<a class="el" href="_m_k_channel_8h_source.html">MKChannel.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jun 19 2013 00:50:50 for MumbleKit by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.2
</small></address>
</body>
</html>
|
