diff options
| author | Mikkel Krautz <mikkel@krautz.dk> | 2011-08-03 19:36:22 +0400 |
|---|---|---|
| committer | Mikkel Krautz <mikkel@krautz.dk> | 2011-08-03 19:36:22 +0400 |
| commit | 4188e8e4da5b511ae2e13643a715f377f65ad9d0 (patch) | |
| tree | e23ab34072079611f340802853611bea4ed4500b | |
| parent | e814e0570fd5abe383e6a1e8031a9e59d3f0267e (diff) | |
doc: update to MumbleKit 56d5bdb3ae83c75babd7d54cb34de527a7a482f2
| -rw-r--r-- | Classes/MKAudio.html | 2 | ||||
| -rw-r--r-- | Classes/MKCertificate.html | 2 | ||||
| -rw-r--r-- | Classes/MKChannel.html | 785 | ||||
| -rw-r--r-- | Classes/MKConnection.html | 4 | ||||
| -rw-r--r-- | Classes/MKConnectionController.html | 2 | ||||
| -rw-r--r-- | Classes/MKServerModel.html | 782 | ||||
| -rw-r--r-- | Classes/MKServerPinger.html | 431 | ||||
| -rw-r--r-- | Classes/MKServices.html | 386 | ||||
| -rw-r--r-- | Classes/MKUser.html | 1178 | ||||
| -rw-r--r-- | Classes/MKVersion.html | 347 | ||||
| -rw-r--r-- | Protocols/MKConnectionDelegate.html | 2 | ||||
| -rw-r--r-- | Protocols/MKMessageHandler.html | 4 | ||||
| -rw-r--r-- | Protocols/MKServerModelDelegate.html | 1891 | ||||
| -rw-r--r-- | hierarchy.html | 14 | ||||
| -rw-r--r-- | index.html | 14 |
15 files changed, 5805 insertions, 39 deletions
diff --git a/Classes/MKAudio.html b/Classes/MKAudio.html index bb8ab77..d853e49 100644 --- a/Classes/MKAudio.html +++ b/Classes/MKAudio.html @@ -697,7 +697,7 @@ Forced-transmit is used to implemented push-to-talk functionality.</p> <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-07-31)</span><br /> + <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-08-03)</span><br /> <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p> diff --git a/Classes/MKCertificate.html b/Classes/MKCertificate.html index b1b808f..cd251e0 100644 --- a/Classes/MKCertificate.html +++ b/Classes/MKCertificate.html @@ -1084,7 +1084,7 @@ was not found.</p> <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-07-31)</span><br /> + <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-08-03)</span><br /> <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p> diff --git a/Classes/MKChannel.html b/Classes/MKChannel.html new file mode 100644 index 0000000..ff28e1e --- /dev/null +++ b/Classes/MKChannel.html @@ -0,0 +1,785 @@ +<!DOCTYPE HTML> +<html> + <head> + <meta http-equiv="Content-Type" content="html/html; charset=utf-8" /> + <title>MKChannel Class Reference</title> + <meta id="xcode-display" name="xcode-display" content="render"/> + <meta name="viewport" content="width=550" /> + <link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" /> + <link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" /> + <meta name="generator" content="appledoc 2.0.4 (build 703)" /> + </head> + <body> + <header id="top_header"> + <div id="library" class="hideInXcode"> + <h1><a id="libraryTitle" href="../index.html">MumbleKit </a></h1> + <a id="developerHome" href="../index.html">Mumble Developers</a> + </div> + + <div id="title" role="banner"> + <h1 class="hideInXcode">MKChannel Class Reference</h1> + </div> + <ul id="headerButtons" role="toolbar"> + <li id="toc_button"> + <button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button> + </li> + <li id="jumpto_button" role="navigation"> + <select id="jumpTo"> + <option value="top">Jump To…</option> + + <option value="overview">Overview</option> + + + + + <option value="tasks">Tasks</option> + + + + + + + + + + <option value="instance_methods">Instance Methods</option> + + <option value="//api/name/channelDescription"> - channelDescription</option> + + <option value="//api/name/channelDescriptionHash"> - channelDescriptionHash</option> + + <option value="//api/name/channelId"> - channelId</option> + + <option value="//api/name/channelName"> - channelName</option> + + <option value="//api/name/channels"> - channels</option> + + <option value="//api/name/isLinkedToChannel:"> - isLinkedToChannel:</option> + + <option value="//api/name/isTemporary"> - isTemporary</option> + + <option value="//api/name/linkedChannels"> - linkedChannels</option> + + <option value="//api/name/parent"> - parent</option> + + <option value="//api/name/position"> - position</option> + + <option value="//api/name/users"> - users</option> + + + +</select> + </li> + </ul> + </header> + <nav id="tocContainer" class="isShowingTOC"> + <ul id="toc" role="tree"> + +<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li> + + + + +<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul> + +</ul></li> + + + + + + + + + +<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/channelDescription">channelDescription</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/channelDescriptionHash">channelDescriptionHash</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/channelId">channelId</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/channelName">channelName</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/channels">channels</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isLinkedToChannel:">isLinkedToChannel:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isTemporary">isTemporary</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/linkedChannels">linkedChannels</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/parent">parent</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/position">position</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/users">users</a></span></li> + +</ul></li> + + + </ul> + </nav> + <article> + <div id="contents" class="isShowingTOC" role="main"> + <a title="MKChannel Class Reference" name="top"></a> + <div class="main-navigation navigation-top"> + <ul> + <li><a href="../index.html">Index</a></li> + <li><a href="../hierarchy.html">Hierarchy</a></li> +</ul> + </div> + <div id="header"> + <div class="section-header"> + <h1 class="title title-header">MKChannel Class Reference</h1> + </div> + </div> + <div id="container"> + + <div class="section section-specification"><table cellspacing="0"><tbody> + <tr> + <td class="specification-title">Inherits from</td> + <td class="specification-value">NSObject</td> +</tr><tr> + <td class="specification-title">Declared in</td> + <td class="specification-value">MKChannel.h</td> +</tr> + </tbody></table></div> + + + + + <div class="section section-overview"> + <a title="Overview" name="overview"></a> + <h2 class="subtitle subtitle-overview">Overview</h2> + <p><a href="MKChannel.html">MKChannel</a> represents a channel on a Mumble server. <a href="MKChannel.html">MKChannel</a> objects are owned +by their respective <a href="../Classes/MKServerModel.html">MKServerModel</a> instances.</p> + +<p>The object’s <a href="../Classes/MKServerModel.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 href="MKChannel.html">MKChannel</a> happen in response to +<a href="../Protocols/MKServerModelDelegate.html">MKServerModelDelegate</a> callbacks, and all calls to delegate methods of <a href="../Classes/MKServerModel.html">MKServerModel</a> are +ensured to happen on the same thread that modifies MKChannle objects.</p> + +<p>Thus, if all inspection of the MKChannel’s properties happen in response to +<a href="../Protocols/MKServerModelDelegate.html">MKServerModelDelegate</a> callbacks, everything should be OK.</p> + </div> + + + + + + <div class="section section-tasks"> + <a title="Tasks" name="tasks"></a> + <h2 class="subtitle subtitle-tasks">Tasks</h2> + + + + + + <ul class="task-list"> + <li> + <span class="tooltip"> + <code><a href="#//api/name/channelId">– channelId</a></code> + <span class="tooltip"><p>Returns the channel’s channel ID.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/channelName">– channelName</a></code> + <span class="tooltip"><p>Returns the channel’s name.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/isTemporary">– isTemporary</a></code> + <span class="tooltip"><p>Returns whether or not the channel is temporary.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/position">– position</a></code> + <span class="tooltip"><p>Returns the <a href="#//api/name/position">position</a> of the channel.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/parent">– parent</a></code> + <span class="tooltip"><p>Returns the channel’s <a href="#//api/name/parent">parent</a>.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/channels">– channels</a></code> + <span class="tooltip"><p>Returns an NSArray of the channel’s sub<a href="#//api/name/channels">channels</a> represented as MKChannels.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/users">– users</a></code> + <span class="tooltip"><p>Returns an NSArray of all <a href="#//api/name/users">users</a> in the channel. The <a href="#//api/name/users">users</a> are represented as MKUsers.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/linkedChannels">– linkedChannels</a></code> + <span class="tooltip"><p>Returns an NSArray of all <a href="#//api/name/channels">channels</a> linked to this channel.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/isLinkedToChannel:">– isLinkedToChannel:</a></code> + <span class="tooltip"><p>Checks whether a given channel is linked to the receiving channel.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/channelDescriptionHash">– channelDescriptionHash</a></code> + <span class="tooltip"><p>Returns a channel’s description hash. (On most server implementations, this +is a SHA1 digest).</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/channelDescription">– channelDescription</a></code> + <span class="tooltip"><p>Returns the channel’s description.</p></span> + </span> + + +</li> + </ul> + + </div> + + + + + + + + + + <div class="section section-methods"> + <a title="Instance Methods" name="instance_methods"></a> + <h2 class="subtitle subtitle-methods">Instance Methods</h2> + + <div class="section-method"> + <a name="//api/name/channelDescription" title="channelDescription"></a> + <h3 class="subsubtitle method-title">channelDescription</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns the channel’s description.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (NSString *)channelDescription</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKChannel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/channelDescriptionHash" title="channelDescriptionHash"></a> + <h3 class="subsubtitle method-title">channelDescriptionHash</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns a channel’s description hash. (On most server implementations, this +is a SHA1 digest).</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (NSData *)channelDescriptionHash</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKChannel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/channelId" title="channelId"></a> + <h3 class="subsubtitle method-title">channelId</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns the channel’s channel ID.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (NSUInteger)channelId</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKChannel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/channelName" title="channelName"></a> + <h3 class="subsubtitle method-title">channelName</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns the channel’s name.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (NSString *)channelName</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKChannel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/channels" title="channels"></a> + <h3 class="subsubtitle method-title">channels</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns an NSArray of the channel’s sub<a href="#//api/name/channels">channels</a> represented as MKChannels.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (NSArray *)channels</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKChannel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/isLinkedToChannel:" title="isLinkedToChannel:"></a> + <h3 class="subsubtitle method-title">isLinkedToChannel:</h3> + + + + <div class="method-subsection brief-description"> + <p>Checks whether a given channel is linked to the receiving channel.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (BOOL)isLinkedToChannel:(MKChannel *)<em>channel</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>channel</em></dt> + <dd><p>The channel whose link status should be checked.</p></dd> + </dl> + + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>Returns YES if the receiving channel is linked to channel. +Otherwise, returns NO.</p> + </div> + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKChannel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/isTemporary" title="isTemporary"></a> + <h3 class="subsubtitle method-title">isTemporary</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns whether or not the channel is temporary.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (BOOL)isTemporary</code></div> + + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>Returns YES if the channel is temporary. Returns NO if the channel is permanent.</p> + </div> + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKChannel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/linkedChannels" title="linkedChannels"></a> + <h3 class="subsubtitle method-title">linkedChannels</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns an NSArray of all <a href="#//api/name/channels">channels</a> linked to this channel.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (NSArray *)linkedChannels</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKChannel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/parent" title="parent"></a> + <h3 class="subsubtitle method-title">parent</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns the channel’s <a href="#//api/name/parent">parent</a>.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (MKChannel *)parent</code></div> + + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>The <a href="MKChannel.html">MKChannel</a> object representing the channel’s <a href="#//api/name/parent">parent</a>. +Returns nil if the current channel is the root channel.</p> + </div> + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKChannel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/position" title="position"></a> + <h3 class="subsubtitle method-title">position</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns the <a href="#//api/name/position">position</a> of the channel.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (NSInteger)position</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKChannel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/users" title="users"></a> + <h3 class="subsubtitle method-title">users</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns an NSArray of all <a href="#//api/name/users">users</a> in the channel. The <a href="#//api/name/users">users</a> are represented as MKUsers.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (NSArray *)users</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKChannel.h</code><br /> + </div> + + +</div> + + </div> + + + </div> + <div class="main-navigation navigation-bottom"> + <ul> + <li><a href="../index.html">Index</a></li> + <li><a href="../hierarchy.html">Hierarchy</a></li> +</ul> + </div> + <div id="footer"> + <hr /> + <div class="footer-copyright"> + <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-08-03)</span><br /> + + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p> + + </div> + </div> + </div> + </article> + <script type="text/javascript"> + function jumpToChange() + { + window.location.hash = this.options[this.selectedIndex].value; + } + + function toggleTOC() + { + var contents = document.getElementById('contents'); + var tocContainer = document.getElementById('tocContainer'); + + if (this.getAttribute('class') == 'open') + { + this.setAttribute('class', ''); + contents.setAttribute('class', ''); + tocContainer.setAttribute('class', ''); + + window.name = "hideTOC"; + } + else + { + this.setAttribute('class', 'open'); + contents.setAttribute('class', 'isShowingTOC'); + tocContainer.setAttribute('class', 'isShowingTOC'); + + window.name = ""; + } + return false; + } + + function toggleTOCEntryChildren(e) + { + e.stopPropagation(); + var currentClass = this.getAttribute('class'); + if (currentClass == 'children') { + this.setAttribute('class', 'children open'); + } + else if (currentClass == 'children open') { + this.setAttribute('class', 'children'); + } + return false; + } + + function tocEntryClick(e) + { + e.stopPropagation(); + return true; + } + + function init() + { + var selectElement = document.getElementById('jumpTo'); + selectElement.addEventListener('change', jumpToChange, false); + + var tocButton = document.getElementById('table_of_contents'); + tocButton.addEventListener('click', toggleTOC, false); + + var taskTreeItem = document.getElementById('task_treeitem'); + if (taskTreeItem.getElementsByTagName('li').length > 0) + { + taskTreeItem.setAttribute('class', 'children'); + taskTreeItem.firstChild.setAttribute('class', 'disclosure'); + } + + var tocList = document.getElementById('toc'); + + var tocEntries = tocList.getElementsByTagName('li'); + for (var i = 0; i < tocEntries.length; i++) { + tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false); + } + + var tocLinks = tocList.getElementsByTagName('a'); + for (var i = 0; i < tocLinks.length; i++) { + tocLinks[i].addEventListener('click', tocEntryClick, false); + } + + if (window.name == "hideTOC") { + toggleTOC.call(tocButton); + } + } + + window.onload = init; + </script> + </body> +</html>
\ No newline at end of file diff --git a/Classes/MKConnection.html b/Classes/MKConnection.html index dde35c9..683da96 100644 --- a/Classes/MKConnection.html +++ b/Classes/MKConnection.html @@ -215,7 +215,7 @@ <a title="Overview" name="overview"></a> <h2 class="subtitle subtitle-overview">Overview</h2> <p><a href="MKConnection.html">MKConnection</a> represents a connection to a Mumble server. -It is mostly used together with MKServerModel which translates the wire protocol +It is mostly used together with <a href="../Classes/MKServerModel.html">MKServerModel</a> which translates the wire protocol to Objective-C delegate callbacks.</p> </div> @@ -1390,7 +1390,7 @@ errors. By default this is set to NO.</p></dd> <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-07-31)</span><br /> + <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-08-03)</span><br /> <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p> diff --git a/Classes/MKConnectionController.html b/Classes/MKConnectionController.html index d479a00..1b31574 100644 --- a/Classes/MKConnectionController.html +++ b/Classes/MKConnectionController.html @@ -383,7 +383,7 @@ Note: This will be removed sooner or later, as it should not be part of the cont <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-07-31)</span><br /> + <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-08-03)</span><br /> <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p> diff --git a/Classes/MKServerModel.html b/Classes/MKServerModel.html new file mode 100644 index 0000000..0c5e317 --- /dev/null +++ b/Classes/MKServerModel.html @@ -0,0 +1,782 @@ +<!DOCTYPE HTML> +<html> + <head> + <meta http-equiv="Content-Type" content="html/html; charset=utf-8" /> + <title>MKServerModel Class Reference</title> + <meta id="xcode-display" name="xcode-display" content="render"/> + <meta name="viewport" content="width=550" /> + <link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" /> + <link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" /> + <meta name="generator" content="appledoc 2.0.4 (build 703)" /> + </head> + <body> + <header id="top_header"> + <div id="library" class="hideInXcode"> + <h1><a id="libraryTitle" href="../index.html">MumbleKit </a></h1> + <a id="developerHome" href="../index.html">Mumble Developers</a> + </div> + + <div id="title" role="banner"> + <h1 class="hideInXcode">MKServerModel Class Reference</h1> + </div> + <ul id="headerButtons" role="toolbar"> + <li id="toc_button"> + <button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button> + </li> + <li id="jumpto_button" role="navigation"> + <select id="jumpTo"> + <option value="top">Jump To…</option> + + <option value="overview">Overview</option> + + + + + <option value="tasks">Tasks</option> + + + + + + + + + + <option value="instance_methods">Instance Methods</option> + + <option value="//api/name/addDelegate:"> - addDelegate:</option> + + <option value="//api/name/channelWithId:"> - channelWithId:</option> + + <option value="//api/name/connectedUser"> - connectedUser</option> + + <option value="//api/name/initWithConnection:"> - initWithConnection:</option> + + <option value="//api/name/joinChannel:"> - joinChannel:</option> + + <option value="//api/name/removeDelegate:"> - removeDelegate:</option> + + <option value="//api/name/rootChannel"> - rootChannel</option> + + <option value="//api/name/userWithHash:"> - userWithHash:</option> + + <option value="//api/name/userWithSession:"> - userWithSession:</option> + + + +</select> + </li> + </ul> + </header> + <nav id="tocContainer" class="isShowingTOC"> + <ul id="toc" role="tree"> + +<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li> + + + + +<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Initialization">Initialization</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Handling delegates">Handling delegates</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Users operations">Users operations</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Channel operations">Channel operations</a></span></li> + +</ul></li> + + + + + + + + + +<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/addDelegate:">addDelegate:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/channelWithId:">channelWithId:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/connectedUser">connectedUser</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithConnection:">initWithConnection:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/joinChannel:">joinChannel:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/removeDelegate:">removeDelegate:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/rootChannel">rootChannel</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/userWithHash:">userWithHash:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/userWithSession:">userWithSession:</a></span></li> + +</ul></li> + + + </ul> + </nav> + <article> + <div id="contents" class="isShowingTOC" role="main"> + <a title="MKServerModel Class Reference" name="top"></a> + <div class="main-navigation navigation-top"> + <ul> + <li><a href="../index.html">Index</a></li> + <li><a href="../hierarchy.html">Hierarchy</a></li> +</ul> + </div> + <div id="header"> + <div class="section-header"> + <h1 class="title title-header">MKServerModel Class Reference</h1> + </div> + </div> + <div id="container"> + + <div class="section section-specification"><table cellspacing="0"><tbody> + <tr> + <td class="specification-title">Inherits from</td> + <td class="specification-value">NSObject</td> +</tr><tr> + <td class="specification-title">Conforms to</td> + <td class="specification-value"><a href="../Protocols/MKMessageHandler.html">MKMessageHandler</a></td> +</tr><tr> + <td class="specification-title">Declared in</td> + <td class="specification-value">MKServerModel.h</td> +</tr> + </tbody></table></div> + + + + + <div class="section section-overview"> + <a title="Overview" name="overview"></a> + <h2 class="subtitle subtitle-overview">Overview</h2> + <p><a href="MKServerModel.html">MKServerModel</a> wraps an <a href="../Classes/MKConnection.html">MKConnection</a> and acts as its message handler. It provides an +easy to use interface for interacting with a Mumble server.</p> + </div> + + + + + + <div class="section section-tasks"> + <a title="Tasks" name="tasks"></a> + <h2 class="subtitle subtitle-tasks">Tasks</h2> + + + <a title="Initialization" name="task_Initialization"></a> + <h3 class="subsubtitle task-title">Initialization</h3> + + <ul class="task-list"> + <li> + <span class="tooltip"> + <code><a href="#//api/name/initWithConnection:">– initWithConnection:</a></code> + <span class="tooltip"><p>Initialize a <a href="MKServerModel.html">MKServerModel</a> with the given connection.</p></span> + </span> + + +</li> + </ul> + + + <a title="Handling delegates" name="task_Handling delegates"></a> + <h3 class="subsubtitle task-title">Handling delegates</h3> + + <ul class="task-list"> + <li> + <span class="tooltip"> + <code><a href="#//api/name/addDelegate:">– addDelegate:</a></code> + <span class="tooltip"><p>Add a delegate. The delegate may only implement parts of the <a href="../Protocols/MKServerModelDelegate.html">MKServerModelDelegate</a> protocol.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/removeDelegate:">– removeDelegate:</a></code> + <span class="tooltip"><p>Remove a delegate from the <a href="MKServerModel.html">MKServerModel</a>.</p></span> + </span> + + +</li> + </ul> + + + <a title="Users operations" name="task_Users operations"></a> + <h3 class="subsubtitle task-title">Users operations</h3> + + <ul class="task-list"> + <li> + <span class="tooltip"> + <code><a href="#//api/name/connectedUser">– connectedUser</a></code> + <span class="tooltip"><p>Returns the connected user. The connected user is the user that</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/userWithSession:">– userWithSession:</a></code> + <span class="tooltip"><p>Look up a user by session ID.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/userWithHash:">– userWithHash:</a></code> + <span class="tooltip"><p>Look up a user by hash. Most commonly, the hash of a user is the SHA1 digest +of their X.509 certificate.</p></span> + </span> + + +</li> + </ul> + + + <a title="Channel operations" name="task_Channel operations"></a> + <h3 class="subsubtitle task-title">Channel operations</h3> + + <ul class="task-list"> + <li> + <span class="tooltip"> + <code><a href="#//api/name/rootChannel">– rootChannel</a></code> + <span class="tooltip"><p>Get the root channel of the server the underlying <a href="../Classes/MKConnection.html">MKConnection</a> is currently +connected to.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/channelWithId:">– channelWithId:</a></code> + <span class="tooltip"><p>Look up a channel by its channel ID.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/joinChannel:">– joinChannel:</a></code> + <span class="tooltip"><p>Ask the underlying connection to join the given channel.</p></span> + </span> + + +</li> + </ul> + + </div> + + + + + + + + + + <div class="section section-methods"> + <a title="Instance Methods" name="instance_methods"></a> + <h2 class="subtitle subtitle-methods">Instance Methods</h2> + + <div class="section-method"> + <a name="//api/name/addDelegate:" title="addDelegate:"></a> + <h3 class="subsubtitle method-title">addDelegate:</h3> + + + + <div class="method-subsection brief-description"> + <p>Add a delegate. The delegate may only implement parts of the <a href="../Protocols/MKServerModelDelegate.html">MKServerModelDelegate</a> protocol.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)addDelegate:(id)<em>delegate</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>delegate</em></dt> + <dd><p>The delegate to add.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/channelWithId:" title="channelWithId:"></a> + <h3 class="subsubtitle method-title">channelWithId:</h3> + + + + <div class="method-subsection brief-description"> + <p>Look up a channel by its channel ID.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (MKChannel *)channelWithId:(NSUInteger)<em>channelId</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>channelId</em></dt> + <dd><p>The channel ID to look up.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/connectedUser" title="connectedUser"></a> + <h3 class="subsubtitle method-title">connectedUser</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns the connected user. The connected user is the user that</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (MKUser *)connectedUser</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/initWithConnection:" title="initWithConnection:"></a> + <h3 class="subsubtitle method-title">initWithConnection:</h3> + + + + <div class="method-subsection brief-description"> + <p>Initialize a <a href="MKServerModel.html">MKServerModel</a> with the given connection.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (id)initWithConnection:(MKConnection *)<em>connection</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>connection</em></dt> + <dd><p>The connection that the <a href="MKServerModel.html">MKServerModel</a> should handle.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/joinChannel:" title="joinChannel:"></a> + <h3 class="subsubtitle method-title">joinChannel:</h3> + + + + <div class="method-subsection brief-description"> + <p>Ask the underlying connection to join the given channel.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)joinChannel:(MKChannel *)<em>channel</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>channel</em></dt> + <dd><p>The channel to join.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/removeDelegate:" title="removeDelegate:"></a> + <h3 class="subsubtitle method-title">removeDelegate:</h3> + + + + <div class="method-subsection brief-description"> + <p>Remove a delegate from the <a href="MKServerModel.html">MKServerModel</a>.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)removeDelegate:(id)<em>delegate</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>delegate</em></dt> + <dd><p>The delegate to remove.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/rootChannel" title="rootChannel"></a> + <h3 class="subsubtitle method-title">rootChannel</h3> + + + + <div class="method-subsection brief-description"> + <p>Get the root channel of the server the underlying <a href="../Classes/MKConnection.html">MKConnection</a> is currently +connected to.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (MKChannel *)rootChannel</code></div> + + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>Returns a <a href="../Classes/MKChannel.html">MKChannel</a> object pointing to the root channel.</p> + </div> + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/userWithHash:" title="userWithHash:"></a> + <h3 class="subsubtitle method-title">userWithHash:</h3> + + + + <div class="method-subsection brief-description"> + <p>Look up a user by hash. Most commonly, the hash of a user is the SHA1 digest +of their X.509 certificate.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (MKUser *)userWithHash:(NSString *)<em>hash</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>hash</em></dt> + <dd><p>The hash to look up. (Typically a hex-encoded SHA1 digest).</p></dd> + </dl> + + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>Returns the user with the given hash. Returns nil if the user +does not exist on the server.</p> + </div> + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/userWithSession:" title="userWithSession:"></a> + <h3 class="subsubtitle method-title">userWithSession:</h3> + + + + <div class="method-subsection brief-description"> + <p>Look up a user by session ID.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (MKUser *)userWithSession:(NSUInteger)<em>session</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>session</em></dt> + <dd><p>The session ID to look up.</p></dd> + </dl> + + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>Returns the user with the given session ID. Returns nil +if the user does not exist on the server.</p> + </div> + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + </div> + + + </div> + <div class="main-navigation navigation-bottom"> + <ul> + <li><a href="../index.html">Index</a></li> + <li><a href="../hierarchy.html">Hierarchy</a></li> +</ul> + </div> + <div id="footer"> + <hr /> + <div class="footer-copyright"> + <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-08-03)</span><br /> + + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p> + + </div> + </div> + </div> + </article> + <script type="text/javascript"> + function jumpToChange() + { + window.location.hash = this.options[this.selectedIndex].value; + } + + function toggleTOC() + { + var contents = document.getElementById('contents'); + var tocContainer = document.getElementById('tocContainer'); + + if (this.getAttribute('class') == 'open') + { + this.setAttribute('class', ''); + contents.setAttribute('class', ''); + tocContainer.setAttribute('class', ''); + + window.name = "hideTOC"; + } + else + { + this.setAttribute('class', 'open'); + contents.setAttribute('class', 'isShowingTOC'); + tocContainer.setAttribute('class', 'isShowingTOC'); + + window.name = ""; + } + return false; + } + + function toggleTOCEntryChildren(e) + { + e.stopPropagation(); + var currentClass = this.getAttribute('class'); + if (currentClass == 'children') { + this.setAttribute('class', 'children open'); + } + else if (currentClass == 'children open') { + this.setAttribute('class', 'children'); + } + return false; + } + + function tocEntryClick(e) + { + e.stopPropagation(); + return true; + } + + function init() + { + var selectElement = document.getElementById('jumpTo'); + selectElement.addEventListener('change', jumpToChange, false); + + var tocButton = document.getElementById('table_of_contents'); + tocButton.addEventListener('click', toggleTOC, false); + + var taskTreeItem = document.getElementById('task_treeitem'); + if (taskTreeItem.getElementsByTagName('li').length > 0) + { + taskTreeItem.setAttribute('class', 'children'); + taskTreeItem.firstChild.setAttribute('class', 'disclosure'); + } + + var tocList = document.getElementById('toc'); + + var tocEntries = tocList.getElementsByTagName('li'); + for (var i = 0; i < tocEntries.length; i++) { + tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false); + } + + var tocLinks = tocList.getElementsByTagName('a'); + for (var i = 0; i < tocLinks.length; i++) { + tocLinks[i].addEventListener('click', tocEntryClick, false); + } + + if (window.name == "hideTOC") { + toggleTOC.call(tocButton); + } + } + + window.onload = init; + </script> + </body> +</html>
\ No newline at end of file diff --git a/Classes/MKServerPinger.html b/Classes/MKServerPinger.html new file mode 100644 index 0000000..7b0448c --- /dev/null +++ b/Classes/MKServerPinger.html @@ -0,0 +1,431 @@ +<!DOCTYPE HTML> +<html> + <head> + <meta http-equiv="Content-Type" content="html/html; charset=utf-8" /> + <title>MKServerPinger Class Reference</title> + <meta id="xcode-display" name="xcode-display" content="render"/> + <meta name="viewport" content="width=550" /> + <link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" /> + <link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" /> + <meta name="generator" content="appledoc 2.0.4 (build 703)" /> + </head> + <body> + <header id="top_header"> + <div id="library" class="hideInXcode"> + <h1><a id="libraryTitle" href="../index.html">MumbleKit </a></h1> + <a id="developerHome" href="../index.html">Mumble Developers</a> + </div> + + <div id="title" role="banner"> + <h1 class="hideInXcode">MKServerPinger Class Reference</h1> + </div> + <ul id="headerButtons" role="toolbar"> + <li id="toc_button"> + <button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button> + </li> + <li id="jumpto_button" role="navigation"> + <select id="jumpTo"> + <option value="top">Jump To…</option> + + <option value="overview">Overview</option> + + + + + <option value="tasks">Tasks</option> + + + + + + + + + + <option value="instance_methods">Instance Methods</option> + + <option value="//api/name/delegate"> - delegate</option> + + <option value="//api/name/initWithHostname:port:"> - initWithHostname:port:</option> + + <option value="//api/name/setDelegate:"> - setDelegate:</option> + + + +</select> + </li> + </ul> + </header> + <nav id="tocContainer" class="isShowingTOC"> + <ul id="toc" role="tree"> + +<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li> + + + + +<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul> + +</ul></li> + + + + + + + + + +<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/delegate">delegate</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithHostname:port:">initWithHostname:port:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setDelegate:">setDelegate:</a></span></li> + +</ul></li> + + + </ul> + </nav> + <article> + <div id="contents" class="isShowingTOC" role="main"> + <a title="MKServerPinger Class Reference" name="top"></a> + <div class="main-navigation navigation-top"> + <ul> + <li><a href="../index.html">Index</a></li> + <li><a href="../hierarchy.html">Hierarchy</a></li> +</ul> + </div> + <div id="header"> + <div class="section-header"> + <h1 class="title title-header">MKServerPinger Class Reference</h1> + </div> + </div> + <div id="container"> + + <div class="section section-specification"><table cellspacing="0"><tbody> + <tr> + <td class="specification-title">Inherits from</td> + <td class="specification-value">NSObject</td> +</tr><tr> + <td class="specification-title">Declared in</td> + <td class="specification-value">MKServerPinger.h</td> +</tr> + </tbody></table></div> + + + + + <div class="section section-overview"> + <a title="Overview" name="overview"></a> + <h2 class="subtitle subtitle-overview">Overview</h2> + <p><a href="MKServerPinger.html">MKServerPinger</a> implements a pinger object that can ping and query Mumble +servers for information typically shown in a server list.</p> + +<p>Once a <a href="MKServerPinger.html">MKServerPinger</a> object is created, it will continually ping the remote +server until it is destroyed. Whenever the <a href="MKServerPinger.html">MKServerPinger</a> receives a reply from +the remote server, it will inform its <a href="#//api/name/delegate">delegate</a>.</p> + </div> + + + + + + <div class="section section-tasks"> + <a title="Tasks" name="tasks"></a> + <h2 class="subtitle subtitle-tasks">Tasks</h2> + + + + + + <ul class="task-list"> + <li> + <span class="tooltip"> + <code><a href="#//api/name/initWithHostname:port:">– initWithHostname:port:</a></code> + <span class="tooltip"><p>Initialize a new <a href="MKServerPinger.html">MKServerPinger</a> that pings the server running +on the given hostname and port combination.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/delegate">– delegate</a></code> + <span class="tooltip"><p>Returns the currently-set <a href="#//api/name/delegate">delegate</a> for the <a href="MKServerPinger.html">MKServerPinger</a> object.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/setDelegate:">– setDelegate:</a></code> + <span class="tooltip"><p>Set the <a href="#//api/name/delegate">delegate</a> of the <a href="MKServerPinger.html">MKServerPinger</a> object. The <a href="#//api/name/delegate">delegate</a> will be called +when the remote server responds to a ping request.</p></span> + </span> + + +</li> + </ul> + + </div> + + + + + + + + + + <div class="section section-methods"> + <a title="Instance Methods" name="instance_methods"></a> + <h2 class="subtitle subtitle-methods">Instance Methods</h2> + + <div class="section-method"> + <a name="//api/name/delegate" title="delegate"></a> + <h3 class="subsubtitle method-title">delegate</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns the currently-set <a href="#//api/name/delegate">delegate</a> for the <a href="MKServerPinger.html">MKServerPinger</a> object.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (id<MKServerPingerDelegate>)delegate</code></div> + + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>Returns an object implementing the <a href="../Protocols/MKServerPingerDelegate.html">MKServerPingerDelegate</a> protocol.</p> + </div> + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerPinger.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/initWithHostname:port:" title="initWithHostname:port:"></a> + <h3 class="subsubtitle method-title">initWithHostname:port:</h3> + + + + <div class="method-subsection brief-description"> + <p>Initialize a new <a href="MKServerPinger.html">MKServerPinger</a> that pings the server running +on the given hostname and port combination.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (id)initWithHostname:(NSString *)<em>hostname</em> port:(NSString *)<em>port</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>hostname</em></dt> + <dd><p>The hostname of the server to ping.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>port</em></dt> + <dd><p>The port number of the server to ping.</p></dd> + </dl> + + </div> + + + + <div class="method-subsection return"> + <h4 class="method-subtitle parameter-title">Return Value</h4> + <p>Returns an <a href="MKServerPinger.html">MKServerPinger</a> object. To get ping results, one must +register a <a href="#//api/name/delegate">delegate</a> implementing the <a href="../Protocols/MKServerPingerDelegate.html">MKServerPingerDelegate</a> protocol.</p> + </div> + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerPinger.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/setDelegate:" title="setDelegate:"></a> + <h3 class="subsubtitle method-title">setDelegate:</h3> + + + + <div class="method-subsection brief-description"> + <p>Set the <a href="#//api/name/delegate">delegate</a> of the <a href="MKServerPinger.html">MKServerPinger</a> object. The <a href="#//api/name/delegate">delegate</a> will be called +when the remote server responds to a ping request.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)setDelegate:(id<MKServerPingerDelegate>)<em>delegate</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>delegate</em></dt> + <dd><p>The objec to register as the MKServerPinger’s <a href="#//api/name/delegate">delegate</a>. +Must implement the <a href="../Protocols/MKServerPingerDelegate.html">MKServerPingerDelegate</a> protocol.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerPinger.h</code><br /> + </div> + + +</div> + + </div> + + + </div> + <div class="main-navigation navigation-bottom"> + <ul> + <li><a href="../index.html">Index</a></li> + <li><a href="../hierarchy.html">Hierarchy</a></li> +</ul> + </div> + <div id="footer"> + <hr /> + <div class="footer-copyright"> + <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-08-03)</span><br /> + + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p> + + </div> + </div> + </div> + </article> + <script type="text/javascript"> + function jumpToChange() + { + window.location.hash = this.options[this.selectedIndex].value; + } + + function toggleTOC() + { + var contents = document.getElementById('contents'); + var tocContainer = document.getElementById('tocContainer'); + + if (this.getAttribute('class') == 'open') + { + this.setAttribute('class', ''); + contents.setAttribute('class', ''); + tocContainer.setAttribute('class', ''); + + window.name = "hideTOC"; + } + else + { + this.setAttribute('class', 'open'); + contents.setAttribute('class', 'isShowingTOC'); + tocContainer.setAttribute('class', 'isShowingTOC'); + + window.name = ""; + } + return false; + } + + function toggleTOCEntryChildren(e) + { + e.stopPropagation(); + var currentClass = this.getAttribute('class'); + if (currentClass == 'children') { + this.setAttribute('class', 'children open'); + } + else if (currentClass == 'children open') { + this.setAttribute('class', 'children'); + } + return false; + } + + function tocEntryClick(e) + { + e.stopPropagation(); + return true; + } + + function init() + { + var selectElement = document.getElementById('jumpTo'); + selectElement.addEventListener('change', jumpToChange, false); + + var tocButton = document.getElementById('table_of_contents'); + tocButton.addEventListener('click', toggleTOC, false); + + var taskTreeItem = document.getElementById('task_treeitem'); + if (taskTreeItem.getElementsByTagName('li').length > 0) + { + taskTreeItem.setAttribute('class', 'children'); + taskTreeItem.firstChild.setAttribute('class', 'disclosure'); + } + + var tocList = document.getElementById('toc'); + + var tocEntries = tocList.getElementsByTagName('li'); + for (var i = 0; i < tocEntries.length; i++) { + tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false); + } + + var tocLinks = tocList.getElementsByTagName('a'); + for (var i = 0; i < tocLinks.length; i++) { + tocLinks[i].addEventListener('click', tocEntryClick, false); + } + + if (window.name == "hideTOC") { + toggleTOC.call(tocButton); + } + } + + window.onload = init; + </script> + </body> +</html>
\ No newline at end of file diff --git a/Classes/MKServices.html b/Classes/MKServices.html new file mode 100644 index 0000000..e004944 --- /dev/null +++ b/Classes/MKServices.html @@ -0,0 +1,386 @@ +<!DOCTYPE HTML> +<html> + <head> + <meta http-equiv="Content-Type" content="html/html; charset=utf-8" /> + <title>MKServices Class Reference</title> + <meta id="xcode-display" name="xcode-display" content="render"/> + <meta name="viewport" content="width=550" /> + <link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" /> + <link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" /> + <meta name="generator" content="appledoc 2.0.4 (build 703)" /> + </head> + <body> + <header id="top_header"> + <div id="library" class="hideInXcode"> + <h1><a id="libraryTitle" href="../index.html">MumbleKit </a></h1> + <a id="developerHome" href="../index.html">Mumble Developers</a> + </div> + + <div id="title" role="banner"> + <h1 class="hideInXcode">MKServices Class Reference</h1> + </div> + <ul id="headerButtons" role="toolbar"> + <li id="toc_button"> + <button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button> + </li> + <li id="jumpto_button" role="navigation"> + <select id="jumpTo"> + <option value="top">Jump To…</option> + + <option value="overview">Overview</option> + + + + + <option value="tasks">Tasks</option> + + + + + + + + <option value="class_methods">Class Methods</option> + + <option value="//api/name/regionalServerList"> + regionalServerList</option> + + <option value="//api/name/regionalServerListURL"> + regionalServerListURL</option> + + <option value="//api/name/regionalServicesHost"> + regionalServicesHost</option> + + + + + +</select> + </li> + </ul> + </header> + <nav id="tocContainer" class="isShowingTOC"> + <ul id="toc" role="tree"> + +<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li> + + + + +<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul> + +</ul></li> + + + + + + + +<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#class_methods">Class Methods</a></span><ul> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/regionalServerList">regionalServerList</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/regionalServerListURL">regionalServerListURL</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/regionalServicesHost">regionalServicesHost</a></span></li> + +</ul></li> + + + + + </ul> + </nav> + <article> + <div id="contents" class="isShowingTOC" role="main"> + <a title="MKServices Class Reference" name="top"></a> + <div class="main-navigation navigation-top"> + <ul> + <li><a href="../index.html">Index</a></li> + <li><a href="../hierarchy.html">Hierarchy</a></li> +</ul> + </div> + <div id="header"> + <div class="section-header"> + <h1 class="title title-header">MKServices Class Reference</h1> + </div> + </div> + <div id="container"> + + <div class="section section-specification"><table cellspacing="0"><tbody> + <tr> + <td class="specification-title">Inherits from</td> + <td class="specification-value">NSObject</td> +</tr><tr> + <td class="specification-title">Declared in</td> + <td class="specification-value">MKServices.h</td> +</tr> + </tbody></table></div> + + + + + <div class="section section-overview"> + <a title="Overview" name="overview"></a> + <h2 class="subtitle subtitle-overview">Overview</h2> + <p><a href="MKServices.html">MKServices</a> implements convenience methods for accessing publicly available +Mumble services.</p> + </div> + + + + + + <div class="section section-tasks"> + <a title="Tasks" name="tasks"></a> + <h2 class="subtitle subtitle-tasks">Tasks</h2> + + + + + + <ul class="task-list"> + <li> + <span class="tooltip"> + <code><a href="#//api/name/regionalServicesHost">+ regionalServicesHost</a></code> + <span class="tooltip"><p>Get the hostname of the closest regional services host.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/regionalServerList">+ regionalServerList</a></code> + <span class="tooltip"><p>Get the URL of the server list on a server near the client’s current location.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/regionalServerListURL">+ regionalServerListURL</a></code> + <span class="tooltip"><p>Returns an NSURL version of the URL returned by <a href="#//api/name/regionalServerList">regionalServerList</a>.</p></span> + </span> + + +</li> + </ul> + + </div> + + + + + + + + <div class="section section-methods"> + <a title="Class Methods" name="class_methods"></a> + <h2 class="subtitle subtitle-methods">Class Methods</h2> + + <div class="section-method"> + <a name="//api/name/regionalServerList" title="regionalServerList"></a> + <h3 class="subsubtitle method-title">regionalServerList</h3> + + + + <div class="method-subsection brief-description"> + <p>Get the URL of the server list on a server near the client’s current location.</p> + </div> + + + <div class="method-subsection method-declaration"><code>+ (NSString *)regionalServerList</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServices.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/regionalServerListURL" title="regionalServerListURL"></a> + <h3 class="subsubtitle method-title">regionalServerListURL</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns an NSURL version of the URL returned by <a href="#//api/name/regionalServerList">regionalServerList</a>.</p> + </div> + + + <div class="method-subsection method-declaration"><code>+ (NSURL *)regionalServerListURL</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServices.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/regionalServicesHost" title="regionalServicesHost"></a> + <h3 class="subsubtitle method-title">regionalServicesHost</h3> + + + + <div class="method-subsection brief-description"> + <p>Get the hostname of the closest regional services host.</p> + </div> + + + <div class="method-subsection method-declaration"><code>+ (NSString *)regionalServicesHost</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServices.h</code><br /> + </div> + + +</div> + + </div> + + + + + </div> + <div class="main-navigation navigation-bottom"> + <ul> + <li><a href="../index.html">Index</a></li> + <li><a href="../hierarchy.html">Hierarchy</a></li> +</ul> + </div> + <div id="footer"> + <hr /> + <div class="footer-copyright"> + <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-08-03)</span><br /> + + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p> + + </div> + </div> + </div> + </article> + <script type="text/javascript"> + function jumpToChange() + { + window.location.hash = this.options[this.selectedIndex].value; + } + + function toggleTOC() + { + var contents = document.getElementById('contents'); + var tocContainer = document.getElementById('tocContainer'); + + if (this.getAttribute('class') == 'open') + { + this.setAttribute('class', ''); + contents.setAttribute('class', ''); + tocContainer.setAttribute('class', ''); + + window.name = "hideTOC"; + } + else + { + this.setAttribute('class', 'open'); + contents.setAttribute('class', 'isShowingTOC'); + tocContainer.setAttribute('class', 'isShowingTOC'); + + window.name = ""; + } + return false; + } + + function toggleTOCEntryChildren(e) + { + e.stopPropagation(); + var currentClass = this.getAttribute('class'); + if (currentClass == 'children') { + this.setAttribute('class', 'children open'); + } + else if (currentClass == 'children open') { + this.setAttribute('class', 'children'); + } + return false; + } + + function tocEntryClick(e) + { + e.stopPropagation(); + return true; + } + + function init() + { + var selectElement = document.getElementById('jumpTo'); + selectElement.addEventListener('change', jumpToChange, false); + + var tocButton = document.getElementById('table_of_contents'); + tocButton.addEventListener('click', toggleTOC, false); + + var taskTreeItem = document.getElementById('task_treeitem'); + if (taskTreeItem.getElementsByTagName('li').length > 0) + { + taskTreeItem.setAttribute('class', 'children'); + taskTreeItem.firstChild.setAttribute('class', 'disclosure'); + } + + var tocList = document.getElementById('toc'); + + var tocEntries = tocList.getElementsByTagName('li'); + for (var i = 0; i < tocEntries.length; i++) { + tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false); + } + + var tocLinks = tocList.getElementsByTagName('a'); + for (var i = 0; i < tocLinks.length; i++) { + tocLinks[i].addEventListener('click', tocEntryClick, false); + } + + if (window.name == "hideTOC") { + toggleTOC.call(tocButton); + } + } + + window.onload = init; + </script> + </body> +</html>
\ No newline at end of file diff --git a/Classes/MKUser.html b/Classes/MKUser.html new file mode 100644 index 0000000..7fb8e7d --- /dev/null +++ b/Classes/MKUser.html @@ -0,0 +1,1178 @@ +<!DOCTYPE HTML> +<html> + <head> + <meta http-equiv="Content-Type" content="html/html; charset=utf-8" /> + <title>MKUser Class Reference</title> + <meta id="xcode-display" name="xcode-display" content="render"/> + <meta name="viewport" content="width=550" /> + <link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" /> + <link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" /> + <meta name="generator" content="appledoc 2.0.4 (build 703)" /> + </head> + <body> + <header id="top_header"> + <div id="library" class="hideInXcode"> + <h1><a id="libraryTitle" href="../index.html">MumbleKit </a></h1> + <a id="developerHome" href="../index.html">Mumble Developers</a> + </div> + + <div id="title" role="banner"> + <h1 class="hideInXcode">MKUser Class Reference</h1> + </div> + <ul id="headerButtons" role="toolbar"> + <li id="toc_button"> + <button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button> + </li> + <li id="jumpto_button" role="navigation"> + <select id="jumpTo"> + <option value="top">Jump To…</option> + + <option value="overview">Overview</option> + + + + + <option value="tasks">Tasks</option> + + + + + + + + + + <option value="instance_methods">Instance Methods</option> + + <option value="//api/name/channel"> - channel</option> + + <option value="//api/name/comment"> - comment</option> + + <option value="//api/name/commentHash"> - commentHash</option> + + <option value="//api/name/isAuthenticated"> - isAuthenticated</option> + + <option value="//api/name/isDeafened"> - isDeafened</option> + + <option value="//api/name/isFriend"> - isFriend</option> + + <option value="//api/name/isLocalMuted"> - isLocalMuted</option> + + <option value="//api/name/isMuted"> - isMuted</option> + + <option value="//api/name/isPrioritySpeaker"> - isPrioritySpeaker</option> + + <option value="//api/name/isRecording"> - isRecording</option> + + <option value="//api/name/isSelfDeafened"> - isSelfDeafened</option> + + <option value="//api/name/isSelfMuted"> - isSelfMuted</option> + + <option value="//api/name/isSuppressed"> - isSuppressed</option> + + <option value="//api/name/session"> - session</option> + + <option value="//api/name/talkState"> - talkState</option> + + <option value="//api/name/texture"> - texture</option> + + <option value="//api/name/textureHash"> - textureHash</option> + + <option value="//api/name/userHash"> - userHash</option> + + <option value="//api/name/userId"> - userId</option> + + <option value="//api/name/userName"> - userName</option> + + + +</select> + </li> + </ul> + </header> + <nav id="tocContainer" class="isShowingTOC"> + <ul id="toc" role="tree"> + +<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li> + + + + +<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul> + +</ul></li> + + + + + + + + + +<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/channel">channel</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/comment">comment</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/commentHash">commentHash</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isAuthenticated">isAuthenticated</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isDeafened">isDeafened</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isFriend">isFriend</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isLocalMuted">isLocalMuted</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isMuted">isMuted</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isPrioritySpeaker">isPrioritySpeaker</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isRecording">isRecording</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isSelfDeafened">isSelfDeafened</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isSelfMuted">isSelfMuted</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isSuppressed">isSuppressed</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/session">session</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/talkState">talkState</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/texture">texture</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/textureHash">textureHash</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/userHash">userHash</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/userId">userId</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/userName">userName</a></span></li> + +</ul></li> + + + </ul> + </nav> + <article> + <div id="contents" class="isShowingTOC" role="main"> + <a title="MKUser Class Reference" name="top"></a> + <div class="main-navigation navigation-top"> + <ul> + <li><a href="../index.html">Index</a></li> + <li><a href="../hierarchy.html">Hierarchy</a></li> +</ul> + </div> + <div id="header"> + <div class="section-header"> + <h1 class="title title-header">MKUser Class Reference</h1> + </div> + </div> + <div id="container"> + + <div class="section section-specification"><table cellspacing="0"><tbody> + <tr> + <td class="specification-title">Inherits from</td> + <td class="specification-value">NSObject</td> +</tr><tr> + <td class="specification-title">Declared in</td> + <td class="specification-value">MKUser.h</td> +</tr> + </tbody></table></div> + + + + + <div class="section section-overview"> + <a title="Overview" name="overview"></a> + <h2 class="subtitle subtitle-overview">Overview</h2> + <p><a href="MKUser.html">MKUser</a> represents a user on a Mumble server. A user always resides in a <a href="#//api/name/channel">channel</a>, which is +represented by the <a href="../Classes/MKChannel.html">MKChannel</a> object. <a href="../Classes/MKChannel.html">MKChannel</a> objects are owned by their respective <a href="../Classes/MKServerModel.html">MKServerModel</a> +instances.</p> + +<p>The object’s <a href="../Classes/MKServerModel.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 href="MKUser.html">MKUser</a> happen in response to +<a href="../Protocols/MKServerModelDelegate.html">MKServerModelDelegate</a> callbacks, and all calls to delegate methods of <a href="../Classes/MKServerModel.html">MKServerModel</a> are +ensured to happen on the same thread that modifies MKChannle objects.</p> + +<p>Thus, if all inspection of the MKChannel’s properties happen in response to +<a href="../Protocols/MKServerModelDelegate.html">MKServerModelDelegate</a> callbacks, everything should be OK.</p> + </div> + + + + + + <div class="section section-tasks"> + <a title="Tasks" name="tasks"></a> + <h2 class="subtitle subtitle-tasks">Tasks</h2> + + + + + + <ul class="task-list"> + <li> + <span class="tooltip"> + <code><a href="#//api/name/userId">– userId</a></code> + <span class="tooltip"><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></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/session">– session</a></code> + <span class="tooltip"><p>Returns the user’s <a href="#//api/name/session">session</a> ID. +The <a href="#//api/name/session">session</a> 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></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/userName">– userName</a></code> + <span class="tooltip"><p>Returns the user’s username.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/userHash">– userHash</a></code> + <span class="tooltip"><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></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/talkState">– talkState</a></code> + <span class="tooltip"><p>Returns the user’s current talk state. See MKTalkState for more information.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/isAuthenticated">– isAuthenticated</a></code> + <span class="tooltip"><p>Returns whether or not the user is authenticated.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/isFriend">– isFriend</a></code> + <span class="tooltip"><p>Returns whether or not the receiving user is a friend.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/isMuted">– isMuted</a></code> + <span class="tooltip"><p>Returns whether or not the receiving user is muted.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/isDeafened">– isDeafened</a></code> + <span class="tooltip"><p>Returns whether or not the receiving user is deafened.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/isSuppressed">– isSuppressed</a></code> + <span class="tooltip"><p>Returns whether or not the receiving user is suppressed by the server.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/isLocalMuted">– isLocalMuted</a></code> + <span class="tooltip"><p>Returns whether or not the receiving user is muted by the local client.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/isSelfMuted">– isSelfMuted</a></code> + <span class="tooltip"><p>Returns whether or not the receiving user is self-muted.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/isSelfDeafened">– isSelfDeafened</a></code> + <span class="tooltip"><p>Returns whether or not the receiving user is self-deafened.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/isPrioritySpeaker">– isPrioritySpeaker</a></code> + <span class="tooltip"><p>Returns whether or not the receiving user has the priority speaker flag.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/isRecording">– isRecording</a></code> + <span class="tooltip"><p>Returns whether or not the receiving user has the recording flag.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/channel">– channel</a></code> + <span class="tooltip"><p>Returns the <a href="#//api/name/channel">channel</a> that the receiving user is currently residing in.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/commentHash">– commentHash</a></code> + <span class="tooltip"><p>Returns the server’s hash of the contents of the user’s current <a href="#//api/name/comment">comment</a>.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/comment">– comment</a></code> + <span class="tooltip"><p>Return the user’s current <a href="#//api/name/comment">comment</a> as an NSString.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/textureHash">– textureHash</a></code> + <span class="tooltip"><p>Returns the server’s hash of the user’s current <a href="#//api/name/texture">texture</a>.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/texture">– texture</a></code> + <span class="tooltip"><p>Returns the user’s <a href="#//api/name/texture">texture</a> as an NSData object. The NSData object +contains the binary representation of the user’s <a href="#//api/name/texture">texture</a> as an image +in either JPEG, PNG or ARGB32 format.</p></span> + </span> + + +</li> + </ul> + + </div> + + + + + + + + + + <div class="section section-methods"> + <a title="Instance Methods" name="instance_methods"></a> + <h2 class="subtitle subtitle-methods">Instance Methods</h2> + + <div class="section-method"> + <a name="//api/name/channel" title="channel"></a> + <h3 class="subsubtitle method-title">channel</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns the <a href="#//api/name/channel">channel</a> that the receiving user is currently residing in.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (MKChannel *)channel</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKUser.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/comment" title="comment"></a> + <h3 class="subsubtitle method-title">comment</h3> + + + + <div class="method-subsection brief-description"> + <p>Return the user’s current <a href="#//api/name/comment">comment</a> as an NSString.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (NSString *)comment</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKUser.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/commentHash" title="commentHash"></a> + <h3 class="subsubtitle method-title">commentHash</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns the server’s hash of the contents of the user’s current <a href="#//api/name/comment">comment</a>.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (NSData *)commentHash</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKUser.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/isAuthenticated" title="isAuthenticated"></a> + <h3 class="subsubtitle method-title">isAuthenticated</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns whether or not the user is authenticated.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (BOOL)isAuthenticated</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKUser.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/isDeafened" title="isDeafened"></a> + <h3 class="subsubtitle method-title">isDeafened</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns whether or not the receiving user is deafened.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (BOOL)isDeafened</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKUser.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/isFriend" title="isFriend"></a> + <h3 class="subsubtitle method-title">isFriend</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns whether or not the receiving user is a friend.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (BOOL)isFriend</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKUser.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/isLocalMuted" title="isLocalMuted"></a> + <h3 class="subsubtitle method-title">isLocalMuted</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns whether or not the receiving user is muted by the local client.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (BOOL)isLocalMuted</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKUser.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/isMuted" title="isMuted"></a> + <h3 class="subsubtitle method-title">isMuted</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns whether or not the receiving user is muted.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (BOOL)isMuted</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKUser.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/isPrioritySpeaker" title="isPrioritySpeaker"></a> + <h3 class="subsubtitle method-title">isPrioritySpeaker</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns whether or not the receiving user has the priority speaker flag.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (BOOL)isPrioritySpeaker</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKUser.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/isRecording" title="isRecording"></a> + <h3 class="subsubtitle method-title">isRecording</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns whether or not the receiving user has the recording flag.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (BOOL)isRecording</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKUser.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/isSelfDeafened" title="isSelfDeafened"></a> + <h3 class="subsubtitle method-title">isSelfDeafened</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns whether or not the receiving user is self-deafened.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (BOOL)isSelfDeafened</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKUser.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/isSelfMuted" title="isSelfMuted"></a> + <h3 class="subsubtitle method-title">isSelfMuted</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns whether or not the receiving user is self-muted.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (BOOL)isSelfMuted</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKUser.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/isSuppressed" title="isSuppressed"></a> + <h3 class="subsubtitle method-title">isSuppressed</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns whether or not the receiving user is suppressed by the server.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (BOOL)isSuppressed</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKUser.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/session" title="session"></a> + <h3 class="subsubtitle method-title">session</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns the user’s <a href="#//api/name/session">session</a> ID. +The <a href="#//api/name/session">session</a> 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 class="method-subsection method-declaration"><code>- (NSUInteger)session</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKUser.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/talkState" title="talkState"></a> + <h3 class="subsubtitle method-title">talkState</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns the user’s current talk state. See MKTalkState for more information.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (MKTalkState)talkState</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKUser.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/texture" title="texture"></a> + <h3 class="subsubtitle method-title">texture</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns the user’s <a href="#//api/name/texture">texture</a> as an NSData object. The NSData object +contains the binary representation of the user’s <a href="#//api/name/texture">texture</a> as an image +in either JPEG, PNG or ARGB32 format.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (NSData *)texture</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKUser.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/textureHash" title="textureHash"></a> + <h3 class="subsubtitle method-title">textureHash</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns the server’s hash of the user’s current <a href="#//api/name/texture">texture</a>.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (NSData *)textureHash</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKUser.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/userHash" title="userHash"></a> + <h3 class="subsubtitle method-title">userHash</h3> + + + + <div class="method-subsection brief-description"> + <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 class="method-subsection method-declaration"><code>- (NSString *)userHash</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKUser.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/userId" title="userId"></a> + <h3 class="subsubtitle method-title">userId</h3> + + + + <div class="method-subsection brief-description"> + <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 class="method-subsection method-declaration"><code>- (NSInteger)userId</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKUser.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/userName" title="userName"></a> + <h3 class="subsubtitle method-title">userName</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns the user’s username.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (NSString *)userName</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKUser.h</code><br /> + </div> + + +</div> + + </div> + + + </div> + <div class="main-navigation navigation-bottom"> + <ul> + <li><a href="../index.html">Index</a></li> + <li><a href="../hierarchy.html">Hierarchy</a></li> +</ul> + </div> + <div id="footer"> + <hr /> + <div class="footer-copyright"> + <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-08-03)</span><br /> + + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p> + + </div> + </div> + </div> + </article> + <script type="text/javascript"> + function jumpToChange() + { + window.location.hash = this.options[this.selectedIndex].value; + } + + function toggleTOC() + { + var contents = document.getElementById('contents'); + var tocContainer = document.getElementById('tocContainer'); + + if (this.getAttribute('class') == 'open') + { + this.setAttribute('class', ''); + contents.setAttribute('class', ''); + tocContainer.setAttribute('class', ''); + + window.name = "hideTOC"; + } + else + { + this.setAttribute('class', 'open'); + contents.setAttribute('class', 'isShowingTOC'); + tocContainer.setAttribute('class', 'isShowingTOC'); + + window.name = ""; + } + return false; + } + + function toggleTOCEntryChildren(e) + { + e.stopPropagation(); + var currentClass = this.getAttribute('class'); + if (currentClass == 'children') { + this.setAttribute('class', 'children open'); + } + else if (currentClass == 'children open') { + this.setAttribute('class', 'children'); + } + return false; + } + + function tocEntryClick(e) + { + e.stopPropagation(); + return true; + } + + function init() + { + var selectElement = document.getElementById('jumpTo'); + selectElement.addEventListener('change', jumpToChange, false); + + var tocButton = document.getElementById('table_of_contents'); + tocButton.addEventListener('click', toggleTOC, false); + + var taskTreeItem = document.getElementById('task_treeitem'); + if (taskTreeItem.getElementsByTagName('li').length > 0) + { + taskTreeItem.setAttribute('class', 'children'); + taskTreeItem.firstChild.setAttribute('class', 'disclosure'); + } + + var tocList = document.getElementById('toc'); + + var tocEntries = tocList.getElementsByTagName('li'); + for (var i = 0; i < tocEntries.length; i++) { + tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false); + } + + var tocLinks = tocList.getElementsByTagName('a'); + for (var i = 0; i < tocLinks.length; i++) { + tocLinks[i].addEventListener('click', tocEntryClick, false); + } + + if (window.name == "hideTOC") { + toggleTOC.call(tocButton); + } + } + + window.onload = init; + </script> + </body> +</html>
\ No newline at end of file diff --git a/Classes/MKVersion.html b/Classes/MKVersion.html new file mode 100644 index 0000000..d1e3c25 --- /dev/null +++ b/Classes/MKVersion.html @@ -0,0 +1,347 @@ +<!DOCTYPE HTML> +<html> + <head> + <meta http-equiv="Content-Type" content="html/html; charset=utf-8" /> + <title>MKVersion Class Reference</title> + <meta id="xcode-display" name="xcode-display" content="render"/> + <meta name="viewport" content="width=550" /> + <link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" /> + <link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" /> + <meta name="generator" content="appledoc 2.0.4 (build 703)" /> + </head> + <body> + <header id="top_header"> + <div id="library" class="hideInXcode"> + <h1><a id="libraryTitle" href="../index.html">MumbleKit </a></h1> + <a id="developerHome" href="../index.html">Mumble Developers</a> + </div> + + <div id="title" role="banner"> + <h1 class="hideInXcode">MKVersion Class Reference</h1> + </div> + <ul id="headerButtons" role="toolbar"> + <li id="toc_button"> + <button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button> + </li> + <li id="jumpto_button" role="navigation"> + <select id="jumpTo"> + <option value="top">Jump To…</option> + + <option value="overview">Overview</option> + + + + + <option value="tasks">Tasks</option> + + + + + + + + <option value="class_methods">Class Methods</option> + + <option value="//api/name/hexVersion"> + hexVersion</option> + + <option value="//api/name/releaseString"> + releaseString</option> + + + + + +</select> + </li> + </ul> + </header> + <nav id="tocContainer" class="isShowingTOC"> + <ul id="toc" role="tree"> + +<li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li> + + + + +<li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul> + +</ul></li> + + + + + + + +<li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#class_methods">Class Methods</a></span><ul> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/hexVersion">hexVersion</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/releaseString">releaseString</a></span></li> + +</ul></li> + + + + + </ul> + </nav> + <article> + <div id="contents" class="isShowingTOC" role="main"> + <a title="MKVersion Class Reference" name="top"></a> + <div class="main-navigation navigation-top"> + <ul> + <li><a href="../index.html">Index</a></li> + <li><a href="../hierarchy.html">Hierarchy</a></li> +</ul> + </div> + <div id="header"> + <div class="section-header"> + <h1 class="title title-header">MKVersion Class Reference</h1> + </div> + </div> + <div id="container"> + + <div class="section section-specification"><table cellspacing="0"><tbody> + <tr> + <td class="specification-title">Inherits from</td> + <td class="specification-value">NSObject</td> +</tr><tr> + <td class="specification-title">Declared in</td> + <td class="specification-value">MKVersion.h</td> +</tr> + </tbody></table></div> + + + + + <div class="section section-overview"> + <a title="Overview" name="overview"></a> + <h2 class="subtitle subtitle-overview">Overview</h2> + <p><a href="MKVersion.html">MKVersion</a> is a helper class that contains version information regarding +the MumbleKit framework. It also exports the version information that +the current build of the MumbleKit framework transmits to any remote +server that it connects to.</p> + </div> + + + + + + <div class="section section-tasks"> + <a title="Tasks" name="tasks"></a> + <h2 class="subtitle subtitle-tasks">Tasks</h2> + + + + + + <ul class="task-list"> + <li> + <span class="tooltip"> + <code><a href="#//api/name/hexVersion">+ hexVersion</a></code> + <span class="tooltip"><p>Returns the hex-encoded version string that the current build +of the MumbleKit framework presents to the remote Mumble server.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/releaseString">+ releaseString</a></code> + <span class="tooltip"><p>Returns the release string that the current build of MumbleKit +presents to remote servers that it connects to.</p></span> + </span> + + +</li> + </ul> + + </div> + + + + + + + + <div class="section section-methods"> + <a title="Class Methods" name="class_methods"></a> + <h2 class="subtitle subtitle-methods">Class Methods</h2> + + <div class="section-method"> + <a name="//api/name/hexVersion" title="hexVersion"></a> + <h3 class="subsubtitle method-title">hexVersion</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns the hex-encoded version string that the current build +of the MumbleKit framework presents to the remote Mumble server.</p> + </div> + + + <div class="method-subsection method-declaration"><code>+ (NSUInteger)hexVersion</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKVersion.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/releaseString" title="releaseString"></a> + <h3 class="subsubtitle method-title">releaseString</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns the release string that the current build of MumbleKit +presents to remote servers that it connects to.</p> + </div> + + + <div class="method-subsection method-declaration"><code>+ (NSString *)releaseString</code></div> + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKVersion.h</code><br /> + </div> + + +</div> + + </div> + + + + + </div> + <div class="main-navigation navigation-bottom"> + <ul> + <li><a href="../index.html">Index</a></li> + <li><a href="../hierarchy.html">Hierarchy</a></li> +</ul> + </div> + <div id="footer"> + <hr /> + <div class="footer-copyright"> + <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-08-03)</span><br /> + + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p> + + </div> + </div> + </div> + </article> + <script type="text/javascript"> + function jumpToChange() + { + window.location.hash = this.options[this.selectedIndex].value; + } + + function toggleTOC() + { + var contents = document.getElementById('contents'); + var tocContainer = document.getElementById('tocContainer'); + + if (this.getAttribute('class') == 'open') + { + this.setAttribute('class', ''); + contents.setAttribute('class', ''); + tocContainer.setAttribute('class', ''); + + window.name = "hideTOC"; + } + else + { + this.setAttribute('class', 'open'); + contents.setAttribute('class', 'isShowingTOC'); + tocContainer.setAttribute('class', 'isShowingTOC'); + + window.name = ""; + } + return false; + } + + function toggleTOCEntryChildren(e) + { + e.stopPropagation(); + var currentClass = this.getAttribute('class'); + if (currentClass == 'children') { + this.setAttribute('class', 'children open'); + } + else if (currentClass == 'children open') { + this.setAttribute('class', 'children'); + } + return false; + } + + function tocEntryClick(e) + { + e.stopPropagation(); + return true; + } + + function init() + { + var selectElement = document.getElementById('jumpTo'); + selectElement.addEventListener('change', jumpToChange, false); + + var tocButton = document.getElementById('table_of_contents'); + tocButton.addEventListener('click', toggleTOC, false); + + var taskTreeItem = document.getElementById('task_treeitem'); + if (taskTreeItem.getElementsByTagName('li').length > 0) + { + taskTreeItem.setAttribute('class', 'children'); + taskTreeItem.firstChild.setAttribute('class', 'disclosure'); + } + + var tocList = document.getElementById('toc'); + + var tocEntries = tocList.getElementsByTagName('li'); + for (var i = 0; i < tocEntries.length; i++) { + tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false); + } + + var tocLinks = tocList.getElementsByTagName('a'); + for (var i = 0; i < tocLinks.length; i++) { + tocLinks[i].addEventListener('click', tocEntryClick, false); + } + + if (window.name == "hideTOC") { + toggleTOC.call(tocButton); + } + } + + window.onload = init; + </script> + </body> +</html>
\ No newline at end of file diff --git a/Protocols/MKConnectionDelegate.html b/Protocols/MKConnectionDelegate.html index b32ed40..4bb20f0 100644 --- a/Protocols/MKConnectionDelegate.html +++ b/Protocols/MKConnectionDelegate.html @@ -409,7 +409,7 @@ with the server.</p> <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-07-31)</span><br /> + <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-08-03)</span><br /> <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p> diff --git a/Protocols/MKMessageHandler.html b/Protocols/MKMessageHandler.html index d55c3a7..90b3b65 100644 --- a/Protocols/MKMessageHandler.html +++ b/Protocols/MKMessageHandler.html @@ -171,7 +171,7 @@ object of a <a href="../Classes/MKConnection.html">MKConnection</a> when new con the <a href="../Classes/MKConnection.html">MKConnection</a> itself does not know how to handle are delegated to the messageHandler.</p> <p>Typically, a consumer of <a href="../Classes/MKConnection.html">MKConnection</a> does not directly set a MKMessage handler, but instead -wrap the <a href="../Classes/MKConnection.html">MKConnection</a> in a MKServerModel object which</p> +wrap the <a href="../Classes/MKConnection.html">MKConnection</a> in a <a href="../Classes/MKServerModel.html">MKServerModel</a> object which</p> </div> @@ -1083,7 +1083,7 @@ VoiceTargetMessage value).</p> <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-07-31)</span><br /> + <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-08-03)</span><br /> <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p> diff --git a/Protocols/MKServerModelDelegate.html b/Protocols/MKServerModelDelegate.html index 03fdc8c..19ea4eb 100644 --- a/Protocols/MKServerModelDelegate.html +++ b/Protocols/MKServerModelDelegate.html @@ -44,24 +44,80 @@ <option value="instance_methods">Instance Methods</option> + <option value="//api/name/serverModel:channelAdded:"> - serverModel:channelAdded:</option> + + <option value="//api/name/serverModel:channelDescriptionChanged:"> - serverModel:channelDescriptionChanged:</option> + + <option value="//api/name/serverModel:channelMoved:"> - serverModel:channelMoved:</option> + + <option value="//api/name/serverModel:channelPositionChanged:"> - serverModel:channelPositionChanged:</option> + + <option value="//api/name/serverModel:channelRemoved:"> - serverModel:channelRemoved:</option> + + <option value="//api/name/serverModel:channelRenamed:"> - serverModel:channelRenamed:</option> + <option value="//api/name/serverModel:joinedServerAsUser:"> - serverModel:joinedServerAsUser:</option> + <option value="//api/name/serverModel:linksAdded:toChannel:"> - serverModel:linksAdded:toChannel:</option> + + <option value="//api/name/serverModel:linksChangedForChannel:"> - serverModel:linksChangedForChannel:</option> + + <option value="//api/name/serverModel:linksRemoved:fromChannel:"> - serverModel:linksRemoved:fromChannel:</option> + + <option value="//api/name/serverModel:linksSet:forChannel:"> - serverModel:linksSet:forChannel:</option> + + <option value="//api/name/serverModel:userBanned:byUser:forReason:"> - serverModel:userBanned:byUser:forReason:</option> + <option value="//api/name/serverModel:userCommentChanged:"> - serverModel:userCommentChanged:</option> + <option value="//api/name/serverModel:userDeafened:byUser:"> - serverModel:userDeafened:byUser:</option> + + <option value="//api/name/serverModel:userDisconnected:"> - serverModel:userDisconnected:</option> + <option value="//api/name/serverModel:userJoined:"> - serverModel:userJoined:</option> + <option value="//api/name/serverModel:userKicked:byUser:forReason:"> - serverModel:userKicked:byUser:forReason:</option> + + <option value="//api/name/serverModel:userLeft:"> - serverModel:userLeft:</option> + <option value="//api/name/serverModel:userMoved:toChannel:byUser:"> - serverModel:userMoved:toChannel:byUser:</option> + <option value="//api/name/serverModel:userMuteStateChanged:"> - serverModel:userMuteStateChanged:</option> + + <option value="//api/name/serverModel:userMuted:byUser:"> - serverModel:userMuted:byUser:</option> + + <option value="//api/name/serverModel:userMutedAndDeafened:byUser:"> - serverModel:userMutedAndDeafened:byUser:</option> + + <option value="//api/name/serverModel:userPrioritySpeakerChanged:"> - serverModel:userPrioritySpeakerChanged:</option> + + <option value="//api/name/serverModel:userRecordingStateChanged:"> - serverModel:userRecordingStateChanged:</option> + <option value="//api/name/serverModel:userRemovedSelfMute:"> - serverModel:userRemovedSelfMute:</option> + <option value="//api/name/serverModel:userRemovedSelfMuteAndDeafen:"> - serverModel:userRemovedSelfMuteAndDeafen:</option> + <option value="//api/name/serverModel:userRenamed:"> - serverModel:userRenamed:</option> + <option value="//api/name/serverModel:userSelfMuteDeafenStateChanged:"> - serverModel:userSelfMuteDeafenStateChanged:</option> + <option value="//api/name/serverModel:userSelfMuted:"> - serverModel:userSelfMuted:</option> + <option value="//api/name/serverModel:userSelfMutedAndDeafened:"> - serverModel:userSelfMutedAndDeafened:</option> + + <option value="//api/name/serverModel:userSuppressed:byUser:"> - serverModel:userSuppressed:byUser:</option> + <option value="//api/name/serverModel:userTalkStateChanged:"> - serverModel:userTalkStateChanged:</option> <option value="//api/name/serverModel:userTextureChanged:"> - serverModel:userTextureChanged:</option> + <option value="//api/name/serverModel:userUndeafened:byUser:"> - serverModel:userUndeafened:byUser:</option> + + <option value="//api/name/serverModel:userUnmuted:byUser:"> - serverModel:userUnmuted:byUser:</option> + + <option value="//api/name/serverModel:userUnmutedAndUndeafened:byUser:"> - serverModel:userUnmutedAndUndeafened:byUser:</option> + + <option value="//api/name/serverModel:userUnsuppressed:byUser:"> - serverModel:userUnsuppressed:byUser:</option> + </select> @@ -78,6 +134,20 @@ <li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Upon joining the server">Upon joining the server</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_User changes">User changes</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Self-mute and self-deafen">Self-mute and self-deafen</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Muting, deafening and suppressing">Muting, deafening and suppressing</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Priority speaker and recording">Priority speaker and recording</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Leaving users">Leaving users</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#task_Channel-related events">Channel-related events</a></span></li> + </ul></li> @@ -90,24 +160,80 @@ <li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:channelAdded:">serverModel:channelAdded:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:channelDescriptionChanged:">serverModel:channelDescriptionChanged:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:channelMoved:">serverModel:channelMoved:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:channelPositionChanged:">serverModel:channelPositionChanged:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:channelRemoved:">serverModel:channelRemoved:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:channelRenamed:">serverModel:channelRenamed:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:joinedServerAsUser:">serverModel:joinedServerAsUser:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:linksAdded:toChannel:">serverModel:linksAdded:toChannel:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:linksChangedForChannel:">serverModel:linksChangedForChannel:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:linksRemoved:fromChannel:">serverModel:linksRemoved:fromChannel:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:linksSet:forChannel:">serverModel:linksSet:forChannel:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userBanned:byUser:forReason:">serverModel:userBanned:byUser:forReason:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userCommentChanged:">serverModel:userCommentChanged:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userDeafened:byUser:">serverModel:userDeafened:byUser:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userDisconnected:">serverModel:userDisconnected:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userJoined:">serverModel:userJoined:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userKicked:byUser:forReason:">serverModel:userKicked:byUser:forReason:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userLeft:">serverModel:userLeft:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userMoved:toChannel:byUser:">serverModel:userMoved:toChannel:byUser:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userMuteStateChanged:">serverModel:userMuteStateChanged:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userMuted:byUser:">serverModel:userMuted:byUser:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userMutedAndDeafened:byUser:">serverModel:userMutedAndDeafened:byUser:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userPrioritySpeakerChanged:">serverModel:userPrioritySpeakerChanged:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userRecordingStateChanged:">serverModel:userRecordingStateChanged:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userRemovedSelfMute:">serverModel:userRemovedSelfMute:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userRemovedSelfMuteAndDeafen:">serverModel:userRemovedSelfMuteAndDeafen:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userRenamed:">serverModel:userRenamed:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userSelfMuteDeafenStateChanged:">serverModel:userSelfMuteDeafenStateChanged:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userSelfMuted:">serverModel:userSelfMuted:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userSelfMutedAndDeafened:">serverModel:userSelfMutedAndDeafened:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userSuppressed:byUser:">serverModel:userSuppressed:byUser:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userTalkStateChanged:">serverModel:userTalkStateChanged:</a></span></li> <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userTextureChanged:">serverModel:userTextureChanged:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userUndeafened:byUser:">serverModel:userUndeafened:byUser:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userUnmuted:byUser:">serverModel:userUnmuted:byUser:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userUnmutedAndUndeafened:byUser:">serverModel:userUnmutedAndUndeafened:byUser:</a></span></li> + + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:userUnsuppressed:byUser:">serverModel:userUnsuppressed:byUser:</a></span></li> + </ul></li> @@ -142,7 +268,7 @@ <div class="section section-overview"> <a title="Overview" name="overview"></a> <h2 class="subtitle subtitle-overview">Overview</h2> - <p><a href="MKServerModelDelegate.html">MKServerModelDelegate</a> is the delegate of MKServerModel. + <p><a href="MKServerModelDelegate.html">MKServerModelDelegate</a> is the delegate of <a href="../Classes/MKServerModel.html">MKServerModel</a>. It is called to notify any registered delegates of events happening on the server, or of replies to previously sent messages.</p> </div> @@ -156,8 +282,8 @@ of replies to previously sent messages.</p> <h2 class="subtitle subtitle-tasks">Tasks</h2> - - + <a title="Upon joining the server" name="task_Upon joining the server"></a> + <h3 class="subsubtitle task-title">Upon joining the server</h3> <ul class="task-list"> <li> @@ -166,31 +292,39 @@ of replies to previously sent messages.</p> <span class="tooltip"><p>Called upon successfully authenticating with a server.</p></span> </span> - <span class="task-item-suffix">required method</span> -</li><li> + +</li> + </ul> + + + <a title="User changes" name="task_User changes"></a> + <h3 class="subsubtitle task-title">User changes</h3> + + <ul class="task-list"> + <li> <span class="tooltip"> <code><a href="#//api/name/serverModel:userJoined:">– serverModel:userJoined:</a></code> <span class="tooltip"><p>Called when a new user joins the server.</p></span> </span> - <span class="task-item-suffix">required method</span> + </li><li> <span class="tooltip"> <code><a href="#//api/name/serverModel:userTalkStateChanged:">– serverModel:userTalkStateChanged:</a></code> <span class="tooltip"><p>Called when the talk state of a user changes. This event is fired when the audio subsystem (<a href="../Classes/MKAudio.html">MKAudio</a> and its minions) notify -the MKServerModel that audio data from a user on the connection handled by the +the <a href="../Classes/MKServerModel.html">MKServerModel</a> that audio data from a user on the connection handled by the server model is being played back.</p></span> </span> - <span class="task-item-suffix">required method</span> + </li><li> <span class="tooltip"> <code><a href="#//api/name/serverModel:userRenamed:">– serverModel:userRenamed:</a></code> <span class="tooltip"><p>Called when a user is renamed.</p></span> </span> - <span class="task-item-suffix">required method</span> + </li><li> <span class="tooltip"> <code><a href="#//api/name/serverModel:userMoved:toChannel:byUser:">– serverModel:userMoved:toChannel:byUser:</a></code> @@ -199,35 +333,274 @@ This is also called when a user changes the channel he resides in (in which case user is equivalent to mover).</p></span> </span> - <span class="task-item-suffix">required method</span> + </li><li> <span class="tooltip"> <code><a href="#//api/name/serverModel:userCommentChanged:">– serverModel:userCommentChanged:</a></code> <span class="tooltip"><p>Called when a user’s comment is changed.</p></span> </span> - <span class="task-item-suffix">required method</span> + </li><li> <span class="tooltip"> <code><a href="#//api/name/serverModel:userTextureChanged:">– serverModel:userTextureChanged:</a></code> <span class="tooltip"><p>Called when a user’s texture is changed.</p></span> </span> - <span class="task-item-suffix">required method</span> -</li><li> + +</li> + </ul> + + + <a title="Self-mute and self-deafen" name="task_Self-mute and self-deafen"></a> + <h3 class="subsubtitle task-title">Self-mute and self-deafen</h3> + + <ul class="task-list"> + <li> <span class="tooltip"> <code><a href="#//api/name/serverModel:userSelfMuted:">– serverModel:userSelfMuted:</a></code> <span class="tooltip"><p>Called when a user self-mutes himself.</p></span> </span> - <span class="task-item-suffix">required method</span> + </li><li> <span class="tooltip"> <code><a href="#//api/name/serverModel:userRemovedSelfMute:">– serverModel:userRemovedSelfMute:</a></code> - <span class="tooltip"><p>Called when a user un-self-mutes himself.</p></span> + <span class="tooltip"><p>Called when a user removes his self-mute status.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:userSelfMutedAndDeafened:">– serverModel:userSelfMutedAndDeafened:</a></code> + <span class="tooltip"><p>Called when a user self-mute-deafens himself.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:userRemovedSelfMuteAndDeafen:">– serverModel:userRemovedSelfMuteAndDeafen:</a></code> + <span class="tooltip"><p>Called when a user removes his self-mute-deafen status.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:userSelfMuteDeafenStateChanged:">– serverModel:userSelfMuteDeafenStateChanged:</a></code> + <span class="tooltip"><p>Called by the <a href="../Classes/MKServerModel.html">MKServerModel</a> when a user’s self-mute-deafen status changes.</p></span> + </span> + + +</li> + </ul> + + + <a title="Muting, deafening and suppressing" name="task_Muting, deafening and suppressing"></a> + <h3 class="subsubtitle task-title">Muting, deafening and suppressing</h3> + + <ul class="task-list"> + <li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:userMutedAndDeafened:byUser:">– serverModel:userMutedAndDeafened:byUser:</a></code> + <span class="tooltip"><p>Called when a user mutes-deafens another user.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:userUnmutedAndUndeafened:byUser:">– serverModel:userUnmutedAndUndeafened:byUser:</a></code> + <span class="tooltip"><p>Called when a user removes mute-deafen status from another user.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:userMuted:byUser:">– serverModel:userMuted:byUser:</a></code> + <span class="tooltip"><p>Called when a user is muted by another user.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:userUnmuted:byUser:">– serverModel:userUnmuted:byUser:</a></code> + <span class="tooltip"><p>Called when a user is unmuted by another user.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:userDeafened:byUser:">– serverModel:userDeafened:byUser:</a></code> + <span class="tooltip"><p>Called when a user is deafened by another user.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:userUndeafened:byUser:">– serverModel:userUndeafened:byUser:</a></code> + <span class="tooltip"><p>Called when a user is undeafened by another user.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:userSuppressed:byUser:">– serverModel:userSuppressed:byUser:</a></code> + <span class="tooltip"><p>Called when a user is suppressed by another user.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:userUnsuppressed:byUser:">– serverModel:userUnsuppressed:byUser:</a></code> + <span class="tooltip"><p>Called when a user is unsuppressed by another user.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:userMuteStateChanged:">– serverModel:userMuteStateChanged:</a></code> + <span class="tooltip"><p>Called when a user’s mute state changes.</p></span> + </span> + + +</li> + </ul> + + + <a title="Priority speaker and recording" name="task_Priority speaker and recording"></a> + <h3 class="subsubtitle task-title">Priority speaker and recording</h3> + + <ul class="task-list"> + <li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:userPrioritySpeakerChanged:">– serverModel:userPrioritySpeakerChanged:</a></code> + <span class="tooltip"><p>Called when a user’s priorty speaker flag changes.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:userRecordingStateChanged:">– serverModel:userRecordingStateChanged:</a></code> + <span class="tooltip"><p>Called when a user’s recording flag changes.</p></span> + </span> + + +</li> + </ul> + + + <a title="Leaving users" name="task_Leaving users"></a> + <h3 class="subsubtitle task-title">Leaving users</h3> + + <ul class="task-list"> + <li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:userBanned:byUser:forReason:">– serverModel:userBanned:byUser:forReason:</a></code> + <span class="tooltip"><p>Called when a user is banned by another user (or the server). +When a user is banned, he is also kicked from the server at the +same time.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:userKicked:byUser:forReason:">– serverModel:userKicked:byUser:forReason:</a></code> + <span class="tooltip"><p>Called when a user is kicked by another user (or the server).</p></span> </span> - <span class="task-item-suffix">required method</span> + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:userDisconnected:">– serverModel:userDisconnected:</a></code> + <span class="tooltip"><p>Called when a user disconnects from the server.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:userLeft:">– serverModel:userLeft:</a></code> + <span class="tooltip"><p>Called when a user leaves the server.</p></span> + </span> + + +</li> + </ul> + + + <a title="Channel-related events" name="task_Channel-related events"></a> + <h3 class="subsubtitle task-title">Channel-related events</h3> + + <ul class="task-list"> + <li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:channelAdded:">– serverModel:channelAdded:</a></code> + <span class="tooltip"><p>Called when a new channel is added.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:channelRemoved:">– serverModel:channelRemoved:</a></code> + <span class="tooltip"><p>Called when a channel is removed from the server.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:channelRenamed:">– serverModel:channelRenamed:</a></code> + <span class="tooltip"><p>Called when a channel is renamed.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:channelPositionChanged:">– serverModel:channelPositionChanged:</a></code> + <span class="tooltip"><p>Called when a channel’s position is changed.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:channelMoved:">– serverModel:channelMoved:</a></code> + <span class="tooltip"><p>Called when a channel (and all of its subchannels, and users) is re-parented.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:channelDescriptionChanged:">– serverModel:channelDescriptionChanged:</a></code> + <span class="tooltip"><p>Called when a channel description is changed.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:linksSet:forChannel:">– serverModel:linksSet:forChannel:</a></code> + <span class="tooltip"><p>Called when a complete list of links for a channel is receieved. (This happens +mostly during initial connect).</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:linksAdded:toChannel:">– serverModel:linksAdded:toChannel:</a></code> + <span class="tooltip"><p>Called when new channels links are added to a channel.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:linksRemoved:fromChannel:">– serverModel:linksRemoved:fromChannel:</a></code> + <span class="tooltip"><p>Called when channel links are removed from a channel.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:linksChangedForChannel:">– serverModel:linksChangedForChannel:</a></code> + <span class="tooltip"><p>Called when a channel’s links change.</p></span> + </span> + + </li> </ul> @@ -246,6 +619,300 @@ case user is equivalent to mover).</p></span> <h2 class="subtitle subtitle-methods">Instance Methods</h2> <div class="section-method"> + <a name="//api/name/serverModel:channelAdded:" title="serverModel:channelAdded:"></a> + <h3 class="subsubtitle method-title">serverModel:channelAdded:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a new channel is added.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> channelAdded:(MKChannel *)<em>channel</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The MKserverModel in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>channel</em></dt> + <dd><p>The channel that was added.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/serverModel:channelDescriptionChanged:" title="serverModel:channelDescriptionChanged:"></a> + <h3 class="subsubtitle method-title">serverModel:channelDescriptionChanged:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a channel description is changed.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> channelDescriptionChanged:(MKChannel *)<em>channel</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>channel</em></dt> + <dd><p>The channel whose description was changed.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/serverModel:channelMoved:" title="serverModel:channelMoved:"></a> + <h3 class="subsubtitle method-title">serverModel:channelMoved:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a channel (and all of its subchannels, and users) is re-parented.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> channelMoved:(MKChannel *)<em>channel</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>channel</em></dt> + <dd><p>The channel that was moved.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/serverModel:channelPositionChanged:" title="serverModel:channelPositionChanged:"></a> + <h3 class="subsubtitle method-title">serverModel:channelPositionChanged:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a channel’s position is changed.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> channelPositionChanged:(MKChannel *)<em>channel</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>channel</em></dt> + <dd><p>The channel whose position was changed.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/serverModel:channelRemoved:" title="serverModel:channelRemoved:"></a> + <h3 class="subsubtitle method-title">serverModel:channelRemoved:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a channel is removed from the server.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> channelRemoved:(MKChannel *)<em>channel</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>channel</em></dt> + <dd><p>The channel that was removed.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/serverModel:channelRenamed:" title="serverModel:channelRenamed:"></a> + <h3 class="subsubtitle method-title">serverModel:channelRenamed:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a channel is renamed.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> channelRenamed:(MKChannel *)<em>channel</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>channel</em></dt> + <dd><p>The channel that was renamed.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> <a name="//api/name/serverModel:joinedServerAsUser:" title="serverModel:joinedServerAsUser:"></a> <h3 class="subsubtitle method-title">serverModel:joinedServerAsUser:</h3> @@ -264,12 +931,286 @@ case user is equivalent to mover).</p></span> <dl class="argument-def parameter-def"> <dt><em>model</em></dt> - <dd><p>The MKServerModel object in which this event originated.</p></dd> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> object in which this event originated.</p></dd> </dl> <dl class="argument-def parameter-def"> <dt><em>user</em></dt> - <dd><p>The MKUser object representing the local user.</p></dd> + <dd><p>The <a href="../Classes/MKUser.html">MKUser</a> object representing the local user.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/serverModel:linksAdded:toChannel:" title="serverModel:linksAdded:toChannel:"></a> + <h3 class="subsubtitle method-title">serverModel:linksAdded:toChannel:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when new channels links are added to a channel.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> linksAdded:(NSArray *)<em>newLinks</em> toChannel:(MKChannel *)<em>channel</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>newLinks</em></dt> + <dd><p>An array of channels that the channel was linked to.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>channel</em></dt> + <dd><p>The channel that the links were added to.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/serverModel:linksChangedForChannel:" title="serverModel:linksChangedForChannel:"></a> + <h3 class="subsubtitle method-title">serverModel:linksChangedForChannel:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a channel’s links change.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> linksChangedForChannel:(MKChannel *)<em>channel</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>channel</em></dt> + <dd><p>The channel whose links changed.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/serverModel:linksRemoved:fromChannel:" title="serverModel:linksRemoved:fromChannel:"></a> + <h3 class="subsubtitle method-title">serverModel:linksRemoved:fromChannel:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when channel links are removed from a channel.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> linksRemoved:(NSArray *)<em>removedLinks</em> fromChannel:(MKChannel *)<em>channel</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>removedLinks</em></dt> + <dd><p>An array of channels that were unlinked from the channel.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>channel</em></dt> + <dd><p>The channel that the links were removed from.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/serverModel:linksSet:forChannel:" title="serverModel:linksSet:forChannel:"></a> + <h3 class="subsubtitle method-title">serverModel:linksSet:forChannel:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a complete list of links for a channel is receieved. (This happens +mostly during initial connect).</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> linksSet:(NSArray *)<em>newLinks</em> forChannel:(MKChannel *)<em>channel</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>newLinks</em></dt> + <dd><p>An array of channels whose links were changed.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>channel</em></dt> + <dd><p>The channel for which newLinks were set for.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/serverModel:userBanned:byUser:forReason:" title="serverModel:userBanned:byUser:forReason:"></a> + <h3 class="subsubtitle method-title">serverModel:userBanned:byUser:forReason:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a user is banned by another user (or the server). +When a user is banned, he is also kicked from the server at the +same time.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userBanned:(MKUser *)<em>user</em> byUser:(MKUser *)<em>actor</em> forReason:(NSString *)<em>reason</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>user</em></dt> + <dd><p>The user that was banned.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>actor</em></dt> + <dd><p>The user that banned the other user. May be nil if the +ban was initiated by the server.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>reason</em></dt> + <dd><p>The reason for the ban.</p></dd> </dl> </div> @@ -313,7 +1254,7 @@ case user is equivalent to mover).</p></span> <dl class="argument-def parameter-def"> <dt><em>model</em></dt> - <dd><p>The MKServerModel in which this event originated.</p></dd> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> </dl> <dl class="argument-def parameter-def"> @@ -344,6 +1285,110 @@ case user is equivalent to mover).</p></span> </div> <div class="section-method"> + <a name="//api/name/serverModel:userDeafened:byUser:" title="serverModel:userDeafened:byUser:"></a> + <h3 class="subsubtitle method-title">serverModel:userDeafened:byUser:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a user is deafened by another user.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userDeafened:(MKUser *)<em>user</em> byUser:(MKUser *)<em>actor</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>user</em></dt> + <dd><p>The user who was deafened.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>actor</em></dt> + <dd><p>The user who deafened the other user. May be nil if the user was deafened by +the server.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/serverModel:userDisconnected:" title="serverModel:userDisconnected:"></a> + <h3 class="subsubtitle method-title">serverModel:userDisconnected:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a user disconnects from the server.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userDisconnected:(MKUser *)<em>user</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>user</em></dt> + <dd><p>The user that disconnected.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> <a name="//api/name/serverModel:userJoined:" title="serverModel:userJoined:"></a> <h3 class="subsubtitle method-title">serverModel:userJoined:</h3> @@ -362,7 +1407,7 @@ case user is equivalent to mover).</p></span> <dl class="argument-def parameter-def"> <dt><em>model</em></dt> - <dd><p>The MKServerModel object in which this event originated.</p></dd> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> object in which this event originated.</p></dd> </dl> <dl class="argument-def parameter-def"> @@ -393,6 +1438,115 @@ case user is equivalent to mover).</p></span> </div> <div class="section-method"> + <a name="//api/name/serverModel:userKicked:byUser:forReason:" title="serverModel:userKicked:byUser:forReason:"></a> + <h3 class="subsubtitle method-title">serverModel:userKicked:byUser:forReason:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a user is kicked by another user (or the server).</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userKicked:(MKUser *)<em>user</em> byUser:(MKUser *)<em>actor</em> forReason:(NSString *)<em>reason</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>user</em></dt> + <dd><p>The user that was kicked.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>actor</em></dt> + <dd><p>The user that kicked the other user. May be nil if the +server initiated the kick.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>reason</em></dt> + <dd><p>The reason for kicking the user off the server.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/serverModel:userLeft:" title="serverModel:userLeft:"></a> + <h3 class="subsubtitle method-title">serverModel:userLeft:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a user leaves the server.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userLeft:(MKUser *)<em>user</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>user</em></dt> + <dd><p>The user that left the server.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> <a name="//api/name/serverModel:userMoved:toChannel:byUser:" title="serverModel:userMoved:toChannel:byUser:"></a> <h3 class="subsubtitle method-title">serverModel:userMoved:toChannel:byUser:</h3> @@ -413,7 +1567,7 @@ case user is equivalent to mover).</p> <dl class="argument-def parameter-def"> <dt><em>model</em></dt> - <dd><p>The MKServerModel object in which this event originated.</p></dd> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> object in which this event originated.</p></dd> </dl> <dl class="argument-def parameter-def"> @@ -460,13 +1614,270 @@ performed by the server, mover is nil.</p></dd> </div> <div class="section-method"> + <a name="//api/name/serverModel:userMuteStateChanged:" title="serverModel:userMuteStateChanged:"></a> + <h3 class="subsubtitle method-title">serverModel:userMuteStateChanged:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a user’s mute state changes.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userMuteStateChanged:(MKUser *)<em>user</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>user</em></dt> + <dd><p>The user whose mute state changed.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/serverModel:userMuted:byUser:" title="serverModel:userMuted:byUser:"></a> + <h3 class="subsubtitle method-title">serverModel:userMuted:byUser:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a user is muted by another user.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userMuted:(MKUser *)<em>user</em> byUser:(MKUser *)<em>actor</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>user</em></dt> + <dd><p>The user who was muted.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>actor</em></dt> + <dd><p>The user who muted the other user. May be nil if the user was muted by +the server.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/serverModel:userMutedAndDeafened:byUser:" title="serverModel:userMutedAndDeafened:byUser:"></a> + <h3 class="subsubtitle method-title">serverModel:userMutedAndDeafened:byUser:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a user mutes-deafens another user.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userMutedAndDeafened:(MKUser *)<em>user</em> byUser:(MKUser *)<em>actor</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>user</em></dt> + <dd><p>The user who was mute-deafened.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>actor</em></dt> + <dd><p>The user who initiated the mute-deafen action on the other user. +May be nil if the server mute-deafened the user.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/serverModel:userPrioritySpeakerChanged:" title="serverModel:userPrioritySpeakerChanged:"></a> + <h3 class="subsubtitle method-title">serverModel:userPrioritySpeakerChanged:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a user’s priorty speaker flag changes.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userPrioritySpeakerChanged:(MKUser *)<em>user</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>user</em></dt> + <dd><p>The user whose priority speaker flag changed.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/serverModel:userRecordingStateChanged:" title="serverModel:userRecordingStateChanged:"></a> + <h3 class="subsubtitle method-title">serverModel:userRecordingStateChanged:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a user’s recording flag changes.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userRecordingStateChanged:(MKUser *)<em>user</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The MKServerModle in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>user</em></dt> + <dd><p>The user whose recording flag changed.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> <a name="//api/name/serverModel:userRemovedSelfMute:" title="serverModel:userRemovedSelfMute:"></a> <h3 class="subsubtitle method-title">serverModel:userRemovedSelfMute:</h3> <div class="method-subsection brief-description"> - <p>Called when a user un-self-mutes himself.</p> + <p>Called when a user removes his self-mute status.</p> </div> @@ -478,7 +1889,7 @@ performed by the server, mover is nil.</p></dd> <dl class="argument-def parameter-def"> <dt><em>model</em></dt> - <dd><p>The MKServerModel object in which this event originated.</p></dd> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> object in which this event originated.</p></dd> </dl> <dl class="argument-def parameter-def"> @@ -509,6 +1920,55 @@ performed by the server, mover is nil.</p></dd> </div> <div class="section-method"> + <a name="//api/name/serverModel:userRemovedSelfMuteAndDeafen:" title="serverModel:userRemovedSelfMuteAndDeafen:"></a> + <h3 class="subsubtitle method-title">serverModel:userRemovedSelfMuteAndDeafen:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a user removes his self-mute-deafen status.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userRemovedSelfMuteAndDeafen:(MKUser *)<em>user</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>user</em></dt> + <dd><p>The user who removed his self-mute-deafen status.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> <a name="//api/name/serverModel:userRenamed:" title="serverModel:userRenamed:"></a> <h3 class="subsubtitle method-title">serverModel:userRenamed:</h3> @@ -527,7 +1987,7 @@ performed by the server, mover is nil.</p></dd> <dl class="argument-def parameter-def"> <dt><em>model</em></dt> - <dd><p>The MKServerModel object in which this event originated.</p></dd> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> object in which this event originated.</p></dd> </dl> <dl class="argument-def parameter-def"> @@ -558,6 +2018,55 @@ performed by the server, mover is nil.</p></dd> </div> <div class="section-method"> + <a name="//api/name/serverModel:userSelfMuteDeafenStateChanged:" title="serverModel:userSelfMuteDeafenStateChanged:"></a> + <h3 class="subsubtitle method-title">serverModel:userSelfMuteDeafenStateChanged:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called by the <a href="../Classes/MKServerModel.html">MKServerModel</a> when a user’s self-mute-deafen status changes.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userSelfMuteDeafenStateChanged:(MKUser *)<em>user</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>user</em></dt> + <dd><p>The user whose self-mute-deafen status changed.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> <a name="//api/name/serverModel:userSelfMuted:" title="serverModel:userSelfMuted:"></a> <h3 class="subsubtitle method-title">serverModel:userSelfMuted:</h3> @@ -576,7 +2085,7 @@ performed by the server, mover is nil.</p></dd> <dl class="argument-def parameter-def"> <dt><em>model</em></dt> - <dd><p>The MKServerModel object in which this event originated.</p></dd> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> object in which this event originated.</p></dd> </dl> <dl class="argument-def parameter-def"> @@ -607,6 +2116,110 @@ performed by the server, mover is nil.</p></dd> </div> <div class="section-method"> + <a name="//api/name/serverModel:userSelfMutedAndDeafened:" title="serverModel:userSelfMutedAndDeafened:"></a> + <h3 class="subsubtitle method-title">serverModel:userSelfMutedAndDeafened:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a user self-mute-deafens himself.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userSelfMutedAndDeafened:(MKUser *)<em>user</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>user</em></dt> + <dd><p>The user who self-muted and self-deafened himself.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/serverModel:userSuppressed:byUser:" title="serverModel:userSuppressed:byUser:"></a> + <h3 class="subsubtitle method-title">serverModel:userSuppressed:byUser:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a user is suppressed by another user.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userSuppressed:(MKUser *)<em>user</em> byUser:(MKUser *)<em>actor</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>user</em></dt> + <dd><p>The user who was suppressed.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>actor</em></dt> + <dd><p>The user who suppressed the other user. May be nil if the user was +suppressed by the server.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> <a name="//api/name/serverModel:userTalkStateChanged:" title="serverModel:userTalkStateChanged:"></a> <h3 class="subsubtitle method-title">serverModel:userTalkStateChanged:</h3> @@ -615,7 +2228,7 @@ performed by the server, mover is nil.</p></dd> <div class="method-subsection brief-description"> <p>Called when the talk state of a user changes. This event is fired when the audio subsystem (<a href="../Classes/MKAudio.html">MKAudio</a> and its minions) notify -the MKServerModel that audio data from a user on the connection handled by the +the <a href="../Classes/MKServerModel.html">MKServerModel</a> that audio data from a user on the connection handled by the server model is being played back.</p> </div> @@ -628,7 +2241,7 @@ server model is being played back.</p> <dl class="argument-def parameter-def"> <dt><em>model</em></dt> - <dd><p>The MKServerModel object in which this event originated.</p></dd> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> object in which this event originated.</p></dd> </dl> <dl class="argument-def parameter-def"> @@ -677,7 +2290,7 @@ server model is being played back.</p> <dl class="argument-def parameter-def"> <dt><em>model</em></dt> - <dd><p>The MKServerModel in which this event originated.</p></dd> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> </dl> <dl class="argument-def parameter-def"> @@ -707,6 +2320,226 @@ server model is being played back.</p> </div> + <div class="section-method"> + <a name="//api/name/serverModel:userUndeafened:byUser:" title="serverModel:userUndeafened:byUser:"></a> + <h3 class="subsubtitle method-title">serverModel:userUndeafened:byUser:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a user is undeafened by another user.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userUndeafened:(MKUser *)<em>user</em> byUser:(MKUser *)<em>actor</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>user</em></dt> + <dd><p>The user who was undeafened.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>actor</em></dt> + <dd><p>The user who undeafened the other user. May be nil if the user was undeafened +by the server.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/serverModel:userUnmuted:byUser:" title="serverModel:userUnmuted:byUser:"></a> + <h3 class="subsubtitle method-title">serverModel:userUnmuted:byUser:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a user is unmuted by another user.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userUnmuted:(MKUser *)<em>user</em> byUser:(MKUser *)<em>actor</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>user</em></dt> + <dd><p>The user who was unmuted.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>actor</em></dt> + <dd><p>The user who unmuted the other user. May be nil if the user was unmuted by the +server.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/serverModel:userUnmutedAndUndeafened:byUser:" title="serverModel:userUnmutedAndUndeafened:byUser:"></a> + <h3 class="subsubtitle method-title">serverModel:userUnmutedAndUndeafened:byUser:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a user removes mute-deafen status from another user.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userUnmutedAndUndeafened:(MKUser *)<em>user</em> byUser:(MKUser *)<em>actor</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>user</em></dt> + <dd><p>The user whose mute-deafen status was removed.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>actor</em></dt> + <dd><p>The user who iniated the removal of the other user’s mute-deafen status. +May be nil if the server removed the mute-deafen status.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + + <div class="section-method"> + <a name="//api/name/serverModel:userUnsuppressed:byUser:" title="serverModel:userUnsuppressed:byUser:"></a> + <h3 class="subsubtitle method-title">serverModel:userUnsuppressed:byUser:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called when a user is unsuppressed by another user.</p> + </div> + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userUnsuppressed:(MKUser *)<em>user</em> byUser:(MKUser *)<em>actor</em></code></div> + + + <div class="method-subsection arguments-section parameters"> + <h4 class="method-subtitle parameter-title">Parameters</h4> + + <dl class="argument-def parameter-def"> + <dt><em>model</em></dt> + <dd><p>The <a href="../Classes/MKServerModel.html">MKServerModel</a> in which this event originated.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>user</em></dt> + <dd><p>The user who was unsuppressed.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>actor</em></dt> + <dd><p>The user who unsuppresed the other user. May be nil if the user was +unsupressed by the server.</p></dd> + </dl> + + </div> + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKServerModel.h</code><br /> + </div> + + +</div> + </div> @@ -720,7 +2553,7 @@ server model is being played back.</p> <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-07-31)</span><br /> + <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-08-03)</span><br /> <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p> diff --git a/hierarchy.html b/hierarchy.html index 44d78bc..2f80e42 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -43,8 +43,20 @@ <li><a href="Classes/MKCertificate.html">MKCertificate</a></li> + <li><a href="Classes/MKChannel.html">MKChannel</a></li> + <li><a href="Classes/MKConnectionController.html">MKConnectionController</a></li> + <li><a href="Classes/MKServerModel.html">MKServerModel</a></li> + + <li><a href="Classes/MKServerPinger.html">MKServerPinger</a></li> + + <li><a href="Classes/MKServices.html">MKServices</a></li> + + <li><a href="Classes/MKUser.html">MKUser</a></li> + + <li><a href="Classes/MKVersion.html">MKVersion</a></li> + </ul> </li> @@ -85,7 +97,7 @@ <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-07-31)</span><br /> + <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-08-03)</span><br /> <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p> @@ -41,10 +41,22 @@ <li><a href="Classes/MKCertificate.html">MKCertificate</a></li> + <li><a href="Classes/MKChannel.html">MKChannel</a></li> + <li><a href="Classes/MKConnection.html">MKConnection</a></li> <li><a href="Classes/MKConnectionController.html">MKConnectionController</a></li> + <li><a href="Classes/MKServerModel.html">MKServerModel</a></li> + + <li><a href="Classes/MKServerPinger.html">MKServerPinger</a></li> + + <li><a href="Classes/MKServices.html">MKServices</a></li> + + <li><a href="Classes/MKUser.html">MKUser</a></li> + + <li><a href="Classes/MKVersion.html">MKVersion</a></li> + </ul> </div> @@ -73,7 +85,7 @@ <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-07-31)</span><br /> + <p><span class="copyright">© 2011 Mumble Developers. All rights reserved. (Last updated: 2011-08-03)</span><br /> <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.4 (build 703)</a>.</span></p> |