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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
<!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: MKUser 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_user-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">MKUser Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><code>#import <<a class="el" href="_m_k_user_8h_source.html">MKUser.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for MKUser:</div>
<div class="dyncontent">
<div class="center">
<img src="interface_m_k_user.png" usemap="#MKUser_map" alt=""/>
<map id="MKUser_map" name="MKUser_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:a677f911944253dd5b22139a33cfb475f"><td class="memItemLeft" align="right" valign="top">(NSInteger) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_user.html#a677f911944253dd5b22139a33cfb475f">userId</a></td></tr>
<tr class="separator:a677f911944253dd5b22139a33cfb475f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a814cf4fd2bb9adcae7f5bd6277c18efc"><td class="memItemLeft" align="right" valign="top">(NSUInteger) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_user.html#a814cf4fd2bb9adcae7f5bd6277c18efc">session</a></td></tr>
<tr class="separator:a814cf4fd2bb9adcae7f5bd6277c18efc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9da265caa1cb362d5862323f88fe88aa"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9da265caa1cb362d5862323f88fe88aa"></a>
(NSString *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_user.html#a9da265caa1cb362d5862323f88fe88aa">userName</a></td></tr>
<tr class="memdesc:a9da265caa1cb362d5862323f88fe88aa"><td class="mdescLeft"> </td><td class="mdescRight">Returns the user's username. <br/></td></tr>
<tr class="separator:a9da265caa1cb362d5862323f88fe88aa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae18615cd9072b9aae0d78a9ff645bd13"><td class="memItemLeft" align="right" valign="top">(NSString *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_user.html#ae18615cd9072b9aae0d78a9ff645bd13">userHash</a></td></tr>
<tr class="separator:ae18615cd9072b9aae0d78a9ff645bd13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a33d8fbd3e2a7c88a28992ba5d782339c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a33d8fbd3e2a7c88a28992ba5d782339c"></a>
(MKTalkState) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_user.html#a33d8fbd3e2a7c88a28992ba5d782339c">talkState</a></td></tr>
<tr class="memdesc:a33d8fbd3e2a7c88a28992ba5d782339c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the user's current talk state. See MKTalkState for more information. <br/></td></tr>
<tr class="separator:a33d8fbd3e2a7c88a28992ba5d782339c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a27c8c285ca1bffa7d54a1e625d65d9e9"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a27c8c285ca1bffa7d54a1e625d65d9e9"></a>
(BOOL) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_user.html#a27c8c285ca1bffa7d54a1e625d65d9e9">isAuthenticated</a></td></tr>
<tr class="memdesc:a27c8c285ca1bffa7d54a1e625d65d9e9"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether or not the user is authenticated. <br/></td></tr>
<tr class="separator:a27c8c285ca1bffa7d54a1e625d65d9e9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa58ca7e5b2ce78f1d933a8452443bb94"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa58ca7e5b2ce78f1d933a8452443bb94"></a>
(BOOL) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_user.html#aa58ca7e5b2ce78f1d933a8452443bb94">isFriend</a></td></tr>
<tr class="memdesc:aa58ca7e5b2ce78f1d933a8452443bb94"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether or not the receiving user is a friend. <br/></td></tr>
<tr class="separator:aa58ca7e5b2ce78f1d933a8452443bb94"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abf763f08b290e247e3df9923c280cb58"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abf763f08b290e247e3df9923c280cb58"></a>
(BOOL) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_user.html#abf763f08b290e247e3df9923c280cb58">isMuted</a></td></tr>
<tr class="memdesc:abf763f08b290e247e3df9923c280cb58"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether or not the receiving user is muted. <br/></td></tr>
<tr class="separator:abf763f08b290e247e3df9923c280cb58"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7a823f5be5b1c5517c5461a3423a3bea"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7a823f5be5b1c5517c5461a3423a3bea"></a>
(BOOL) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_user.html#a7a823f5be5b1c5517c5461a3423a3bea">isDeafened</a></td></tr>
<tr class="memdesc:a7a823f5be5b1c5517c5461a3423a3bea"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether or not the receiving user is deafened. <br/></td></tr>
<tr class="separator:a7a823f5be5b1c5517c5461a3423a3bea"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5c89427e92b92c6493acc134acc6fcd6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5c89427e92b92c6493acc134acc6fcd6"></a>
(BOOL) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_user.html#a5c89427e92b92c6493acc134acc6fcd6">isSuppressed</a></td></tr>
<tr class="memdesc:a5c89427e92b92c6493acc134acc6fcd6"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether or not the receiving user is suppressed by the server. <br/></td></tr>
<tr class="separator:a5c89427e92b92c6493acc134acc6fcd6"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a11cead8bcf2daa370534f9b925f7616d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a11cead8bcf2daa370534f9b925f7616d"></a>
(BOOL) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_user.html#a11cead8bcf2daa370534f9b925f7616d">isLocalMuted</a></td></tr>
<tr class="memdesc:a11cead8bcf2daa370534f9b925f7616d"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether or not the receiving user is muted by the local client. <br/></td></tr>
<tr class="separator:a11cead8bcf2daa370534f9b925f7616d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adc03f4e7f81a80c183993cd0a59fb016"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc03f4e7f81a80c183993cd0a59fb016"></a>
(BOOL) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_user.html#adc03f4e7f81a80c183993cd0a59fb016">isSelfMuted</a></td></tr>
<tr class="memdesc:adc03f4e7f81a80c183993cd0a59fb016"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether or not the receiving user is self-muted. <br/></td></tr>
<tr class="separator:adc03f4e7f81a80c183993cd0a59fb016"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abaa55e2e5f0feeedba6f910d497eefe8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abaa55e2e5f0feeedba6f910d497eefe8"></a>
(BOOL) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_user.html#abaa55e2e5f0feeedba6f910d497eefe8">isSelfDeafened</a></td></tr>
<tr class="memdesc:abaa55e2e5f0feeedba6f910d497eefe8"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether or not the receiving user is self-deafened. <br/></td></tr>
<tr class="separator:abaa55e2e5f0feeedba6f910d497eefe8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abd995d6598e4359643a38cd401cdf99c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd995d6598e4359643a38cd401cdf99c"></a>
(BOOL) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_user.html#abd995d6598e4359643a38cd401cdf99c">isPrioritySpeaker</a></td></tr>
<tr class="memdesc:abd995d6598e4359643a38cd401cdf99c"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether or not the receiving user has the priority speaker flag. <br/></td></tr>
<tr class="separator:abd995d6598e4359643a38cd401cdf99c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a443bdc1c9c5c9e31586b44c998fa8e2d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a443bdc1c9c5c9e31586b44c998fa8e2d"></a>
(BOOL) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_user.html#a443bdc1c9c5c9e31586b44c998fa8e2d">isRecording</a></td></tr>
<tr class="memdesc:a443bdc1c9c5c9e31586b44c998fa8e2d"><td class="mdescLeft"> </td><td class="mdescRight">Returns whether or not the receiving user has the recording flag. <br/></td></tr>
<tr class="separator:a443bdc1c9c5c9e31586b44c998fa8e2d"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5ff0bb43e13cac414f3b495e2de11322"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5ff0bb43e13cac414f3b495e2de11322"></a>
(<a class="el" href="interface_m_k_channel.html">MKChannel</a> *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_user.html#a5ff0bb43e13cac414f3b495e2de11322">channel</a></td></tr>
<tr class="memdesc:a5ff0bb43e13cac414f3b495e2de11322"><td class="mdescLeft"> </td><td class="mdescRight">Returns the channel that the receiving user is currently residing in. <br/></td></tr>
<tr class="separator:a5ff0bb43e13cac414f3b495e2de11322"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac43aa7d93357d021347af1f8e0c29c42"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac43aa7d93357d021347af1f8e0c29c42"></a>
(NSData *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_user.html#ac43aa7d93357d021347af1f8e0c29c42">commentHash</a></td></tr>
<tr class="memdesc:ac43aa7d93357d021347af1f8e0c29c42"><td class="mdescLeft"> </td><td class="mdescRight">Returns the server's hash of the contents of the user's current comment. <br/></td></tr>
<tr class="separator:ac43aa7d93357d021347af1f8e0c29c42"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acca82ead6df1f9fd85fc58bf5e299619"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acca82ead6df1f9fd85fc58bf5e299619"></a>
(NSString *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_user.html#acca82ead6df1f9fd85fc58bf5e299619">comment</a></td></tr>
<tr class="memdesc:acca82ead6df1f9fd85fc58bf5e299619"><td class="mdescLeft"> </td><td class="mdescRight">Return the user's current comment as an NSString. <br/></td></tr>
<tr class="separator:acca82ead6df1f9fd85fc58bf5e299619"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a65c504e929b6f700de1e6b449fe28c2c"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a65c504e929b6f700de1e6b449fe28c2c"></a>
(NSData *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_user.html#a65c504e929b6f700de1e6b449fe28c2c">textureHash</a></td></tr>
<tr class="memdesc:a65c504e929b6f700de1e6b449fe28c2c"><td class="mdescLeft"> </td><td class="mdescRight">Returns the server's hash of the user's current texture. <br/></td></tr>
<tr class="separator:a65c504e929b6f700de1e6b449fe28c2c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a43a412f8b987706c657434dd8be73887"><td class="memItemLeft" align="right" valign="top">(NSData *) </td><td class="memItemRight" valign="bottom">- <a class="el" href="interface_m_k_user.html#a43a412f8b987706c657434dd8be73887">texture</a></td></tr>
<tr class="separator:a43a412f8b987706c657434dd8be73887"><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_user.html">MKUser</a> represents a user on a Mumble server. A user always resides in a channel, which is represented by the <a class="el" href="interface_m_k_channel.html">MKChannel</a> object. <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 user 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_user.html">MKUser</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="a814cf4fd2bb9adcae7f5bd6277c18efc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (NSUInteger) session </td>
<td></td>
<td class="paramname"></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the user's session ID. The session ID is mostly an implementation detail – it is an identifier that uniquely identifies a user on a server, regardless of whether or not that user is registered with the server. </p>
</div>
</div>
<a class="anchor" id="a43a412f8b987706c657434dd8be73887"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (NSData *) texture </td>
<td></td>
<td class="paramname"></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the user's texture as an NSData object. The NSData object contains the binary representation of the user's texture as an image in either JPEG, PNG or ARGB32 format. </p>
</div>
</div>
<a class="anchor" id="ae18615cd9072b9aae0d78a9ff645bd13"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (NSString *) userHash </td>
<td></td>
<td class="paramname"></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the user's hash. Typically, the the hash is the SHA1 digest of the user's X.509 certificate, but could be any unique hash that identifies the user. </p>
</div>
</div>
<a class="anchor" id="a677f911944253dd5b22139a33cfb475f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">- (NSInteger) userId </td>
<td></td>
<td class="paramname"></td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns a user's user ID. Only registered users have user IDs. For non-registered users, this ID will be negative. A user ID of 0 signals that the user is the SuperUser. </p>
</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_user_8h_source.html">MKUser.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jun 19 2013 00:37:45 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>
|
