diff options
| author | Mikkel Krautz <mikkel@krautz.dk> | 2012-10-20 00:41:38 +0400 |
|---|---|---|
| committer | Mikkel Krautz <mikkel@krautz.dk> | 2012-10-20 00:41:38 +0400 |
| commit | b903a52088235864d938b4549682fc34ec86e3b8 (patch) | |
| tree | c98e42010c2c2ff5035576001a93b27ba4002e01 | |
| parent | b86205fa61edd612b71430ae0543859774992f2b (diff) | |
doc: update to MumbleKit 2b7696c6578a1dda2b2d06de4d1d2379776dd645
| -rw-r--r-- | Classes/MKAudio.html | 80 | ||||
| -rw-r--r-- | Classes/MKCertificate.html | 134 | ||||
| -rw-r--r-- | Classes/MKChannel.html | 80 | ||||
| -rw-r--r-- | Classes/MKConnection.html | 211 | ||||
| -rw-r--r-- | Classes/MKConnectionController.html | 38 | ||||
| -rw-r--r-- | Classes/MKRSAKeyPair.html | 20 | ||||
| -rw-r--r-- | Classes/MKServerModel.html | 312 | ||||
| -rw-r--r-- | Classes/MKServerPinger.html | 32 | ||||
| -rw-r--r-- | Classes/MKServices.html | 32 | ||||
| -rw-r--r-- | Classes/MKTextMessage.html | 56 | ||||
| -rw-r--r-- | Classes/MKUser.html | 134 | ||||
| -rw-r--r-- | Protocols/MKConnectionDelegate.html | 46 | ||||
| -rw-r--r-- | Protocols/MKMessageHandler.html | 106 | ||||
| -rw-r--r-- | Protocols/MKRSAKeyPairDelegate.html | 20 | ||||
| -rw-r--r-- | Protocols/MKServerModelDelegate.html | 446 | ||||
| -rw-r--r-- | css/styles.css | 53 | ||||
| -rw-r--r-- | hierarchy.html | 6 | ||||
| -rw-r--r-- | index.html | 8 |
18 files changed, 1369 insertions, 445 deletions
diff --git a/Classes/MKAudio.html b/Classes/MKAudio.html index e9f5918..2092620 100644 --- a/Classes/MKAudio.html +++ b/Classes/MKAudio.html @@ -7,7 +7,7 @@ <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.5 (build 774)" /> + <meta name="generator" content="appledoc 2.1 (build 840)" /> </head> <body> <header id="top_header"> @@ -313,9 +313,11 @@ suitable for echo cancellation.</p></span> <p>Get a shared copy of the MKAudio object for this process.</p> </div> - + + <div class="method-subsection method-declaration"><code>+ (MKAudio *)sharedAudio</code></div> - + + @@ -361,9 +363,11 @@ suitable for echo cancellation.</p></span> suitable for echo cancellation.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (BOOL)echoCancellationAvailable</code></div> - + + @@ -396,9 +400,11 @@ suitable for echo cancellation.</p> Forced-transmit is used to implemented push-to-talk functionality.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (BOOL)forceTransmit</code></div> - + + @@ -430,9 +436,11 @@ Forced-transmit is used to implemented push-to-talk functionality.</p> <p>Returns whether or not the MumbleKit audio subsystem is currently running.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (BOOL)isRunning</code></div> - + + @@ -465,9 +473,11 @@ Forced-transmit is used to implemented push-to-talk functionality.</p> into settings.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)readAudioSettings:(MKAudioSettings *)<em>settings</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -509,9 +519,11 @@ into settings.</p> <p>Restarts MumbleKit’s audio subsystem.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)restart</code></div> - + + @@ -543,9 +555,11 @@ into settings.</p> <p>Sets the current force-transmit state.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)setForceTransmit:(BOOL)<em>enableForceTransmit</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -587,9 +601,11 @@ into settings.</p> <p>Starts the MumbleKit audio subsytem.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)start</code></div> - + + @@ -621,9 +637,11 @@ into settings.</p> <p>Stops the MumbleKit audio subsystem.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)stop</code></div> - + + @@ -655,9 +673,11 @@ into settings.</p> <p>Returns the current transmit type (as set by calling setAudioSettings:.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (MKTransmitType)transmitType</code></div> - + + @@ -689,9 +709,11 @@ into settings.</p> <p>Updates the MumbleKit audio subsystem with a new configuration.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)updateAudioSettings:(MKAudioSettings *)<em>settings</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -736,9 +758,9 @@ into settings.</p> <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-05-03)</span><br /> + <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-10-19)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 774)</a>.</span></p> + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 840)</a>.</span></p> </div> </div> @@ -826,6 +848,14 @@ into settings.</p> } window.onload = init; + + // If showing in Xcode, hide the TOC and Header + if (navigator.userAgent.match(/xcode/i)) { + document.getElementById("contents").className = "hideInXcode" + document.getElementById("tocContainer").className = "hideInXcode" + document.getElementById("top_header").className = "hideInXcode" + } + </script> </body> </html>
\ No newline at end of file diff --git a/Classes/MKCertificate.html b/Classes/MKCertificate.html index 4d34074..f707c6a 100644 --- a/Classes/MKCertificate.html +++ b/Classes/MKCertificate.html @@ -7,7 +7,7 @@ <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.5 (build 774)" /> + <meta name="generator" content="appledoc 2.1 (build 840)" /> </head> <body> <header id="top_header"> @@ -458,9 +458,11 @@ certificate.</p></span> <p>Returns a new MKCertificate object from the given certificate and private key.</p> </div> - + + <div class="method-subsection method-declaration"><code>+ (MKCertificate *)certificateWithCertificate:(NSData *)<em>cert</em> privateKey:(NSData *)<em>privkey</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -514,9 +516,11 @@ where one wants to export the certificate in another format (for example PKCS12) <p>Import a certificate from a PKCS12 file with the given password.</p> </div> - + + <div class="method-subsection method-declaration"><code>+ (MKCertificate *)certificateWithPKCS12:(NSData *)<em>pkcs12</em> password:(NSString *)<em>password</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -573,9 +577,11 @@ PKCS12 data blob. The PKCS12 blob will be encrypted and password protected with the given password.</p> </div> - + + <div class="method-subsection method-declaration"><code>+ (NSData *)exportCertificateChainAsPKCS12:(NSArray *)<em>chain</em> withPassword:(NSString *)<em>password</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -640,9 +646,11 @@ This generates a public and private keypair, and uses that key pair to create a signed X.509 certificate that is compatible with Mumble.</p> </div> - + + <div class="method-subsection method-declaration"><code>+ (MKCertificate *)selfSignedCertificateWithName:(NSString *)<em>name</em> email:(NSString *)<em>email</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -699,9 +707,11 @@ This method optionally takes a <a href="../Classes/MKRSAKeyPair.html">MKRSAKeyPa generates.</p> </div> - + + <div class="method-subsection method-declaration"><code>+ (MKCertificate *)selfSignedCertificateWithName:(NSString *)<em>name</em> email:(NSString *)<em>email</em> rsaKeyPair:(MKRSAKeyPair *)<em>keyPair</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -771,9 +781,11 @@ public and private keypair.</p> <p>Returns the CN (Common Name) value of subject of the X.509 certificate.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSString *)commonName</code></div> - + + @@ -811,9 +823,11 @@ public and private keypair.</p> of the receiving MKCertificate object.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSData *)digest</code></div> - + + @@ -851,9 +865,11 @@ of the receiving MKCertificate object.</p> (This email is looked after in Subject Alt. Names.)</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSString *)emailAddress</code></div> - + + @@ -892,9 +908,11 @@ The method will export both the certificate and its corresponding private key (if available) to the PKCS12 data blob.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSData *)exportPKCS12WithPassword:(NSString *)<em>password</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -950,9 +968,11 @@ chain array.</p> <p>Determine whether the certificate has a certificate (and public key)</p> </div> - + + <div class="method-subsection method-declaration"><code>- (BOOL)hasCertificate</code></div> - + + @@ -990,9 +1010,11 @@ Otherwise, returns NO.</p> <p>Determine whether the MKCertficiate object has private key data.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (BOOL)hasPrivateKey</code></div> - + + @@ -1031,9 +1053,11 @@ Otherwise, returns NO.</p> public key of the receiving MKCertificate object.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSString *)hexDigest</code></div> - + + @@ -1071,9 +1095,11 @@ public key of the receiving MKCertificate object.</p> parentCert certificate.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (BOOL)isSignedBy:(MKCertificate *)<em>parentCert</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1120,9 +1146,11 @@ parentCert certificate.</p> <p>Checks whether the signature of the receiver certificate is valid on the given date.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (BOOL)isValidOnDate:(NSDate *)<em>date</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1171,9 +1199,11 @@ parentCert certificate.</p> certificate.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSString *)issuerItem:(NSString *)<em>item</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1223,9 +1253,11 @@ item was not found.</p> <p>Returns the name of the body that issued the X.509 certificate.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSString *)issuerName</code></div> - + + @@ -1265,9 +1297,11 @@ Note that a X.509 certificates can also be revoked, so the Not After date is not an authoritative method of determining certificate validity.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSDate *)notAfter</code></div> - + + @@ -1305,9 +1339,11 @@ an authoritative method of determining certificate validity.</p> This determines the date from which the certificate is deemed valid.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSDate *)notBefore</code></div> - + + @@ -1345,9 +1381,11 @@ This determines the date from which the certificate is deemed valid.</p> certificate.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSString *)subjectItem:(NSString *)<em>item</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1398,9 +1436,11 @@ was not found.</p> This can either be a common name, or an email address, depending on the certificate.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSString *)subjectName</code></div> - + + @@ -1440,9 +1480,9 @@ This can either be a common name, or an email address, depending on the certific <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-05-03)</span><br /> + <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-10-19)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 774)</a>.</span></p> + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 840)</a>.</span></p> </div> </div> @@ -1530,6 +1570,14 @@ This can either be a common name, or an email address, depending on the certific } window.onload = init; + + // If showing in Xcode, hide the TOC and Header + if (navigator.userAgent.match(/xcode/i)) { + document.getElementById("contents").className = "hideInXcode" + document.getElementById("tocContainer").className = "hideInXcode" + document.getElementById("top_header").className = "hideInXcode" + } + </script> </body> </html>
\ No newline at end of file diff --git a/Classes/MKChannel.html b/Classes/MKChannel.html index 8e4fd26..a5564d0 100644 --- a/Classes/MKChannel.html +++ b/Classes/MKChannel.html @@ -7,7 +7,7 @@ <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.5 (build 774)" /> + <meta name="generator" content="appledoc 2.1 (build 840)" /> </head> <body> <header id="top_header"> @@ -285,9 +285,11 @@ is a SHA1 digest).</p></span> <p>Returns the channel’s description.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSString *)channelDescription</code></div> - + + @@ -320,9 +322,11 @@ is a SHA1 digest).</p></span> is a SHA1 digest).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSData *)channelDescriptionHash</code></div> - + + @@ -354,9 +358,11 @@ is a SHA1 digest).</p> <p>Returns the channel’s channel ID.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSUInteger)channelId</code></div> - + + @@ -388,9 +394,11 @@ is a SHA1 digest).</p> <p>Returns the channel’s name.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSString *)channelName</code></div> - + + @@ -422,9 +430,11 @@ is a SHA1 digest).</p> <p>Returns an NSArray of the channel’s subchannels represented as MKChannels.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSArray *)channels</code></div> - + + @@ -456,9 +466,11 @@ is a SHA1 digest).</p> <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> @@ -506,9 +518,11 @@ Otherwise, returns NO.</p> <p>Returns whether or not the channel is temporary.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (BOOL)isTemporary</code></div> - + + @@ -545,9 +559,11 @@ Otherwise, returns NO.</p> <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> - + + @@ -579,9 +595,11 @@ Otherwise, returns NO.</p> <p>Returns the channel’s parent.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (MKChannel *)parent</code></div> - + + @@ -619,9 +637,11 @@ Returns nil if the current channel is the root channel.</p> <p>Returns the position of the channel.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSInteger)position</code></div> - + + @@ -653,9 +673,11 @@ Returns nil if the current channel is the root channel.</p> <p>Returns an NSArray of all users in the channel. The users are represented as MKUsers.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSArray *)users</code></div> - + + @@ -690,9 +712,9 @@ Returns nil if the current channel is the root channel.</p> <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-05-03)</span><br /> + <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-10-19)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 774)</a>.</span></p> + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 840)</a>.</span></p> </div> </div> @@ -780,6 +802,14 @@ Returns nil if the current channel is the root channel.</p> } window.onload = init; + + // If showing in Xcode, hide the TOC and Header + if (navigator.userAgent.match(/xcode/i)) { + document.getElementById("contents").className = "hideInXcode" + document.getElementById("tocContainer").className = "hideInXcode" + document.getElementById("top_header").className = "hideInXcode" + } + </script> </body> </html>
\ No newline at end of file diff --git a/Classes/MKConnection.html b/Classes/MKConnection.html index 0e51c4d..70a3a54 100644 --- a/Classes/MKConnection.html +++ b/Classes/MKConnection.html @@ -7,7 +7,7 @@ <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.5 (build 774)" /> + <meta name="generator" content="appledoc 2.1 (build 840)" /> </head> <body> <header id="top_header"> @@ -94,6 +94,8 @@ <option value="//api/name/setIgnoreSSLVerification:"> - setIgnoreSSLVerification:</option> + <option value="//api/name/shouldUseOpus"> - shouldUseOpus</option> + </select> @@ -182,6 +184,8 @@ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setIgnoreSSLVerification:">setIgnoreSSLVerification:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/shouldUseOpus">shouldUseOpus</a></span></li> + </ul></li> @@ -478,6 +482,13 @@ all possible).</p></span> </span> +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/shouldUseOpus">– shouldUseOpus</a></code> + <span class="tooltip"><p>Returns whether ot not the <a href="#//api/name/connected">connected</a> client should use the Opus codec.</p></span> + </span> + + </li> </ul> @@ -505,9 +516,11 @@ all possible).</p></span> <p>The current elected alpha codec, as determined by the server through a mojority vote.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSUInteger)alphaCodec</code></div> - + + @@ -541,9 +554,11 @@ method has been called), this method must be used to authenticate with the remot Mumble server.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)authenticateWithUsername:(NSString *)<em>user</em> password:(NSString *)<em>pass</em> accessTokens:(NSArray *)<em>tokens</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -601,9 +616,11 @@ This parameter may be nil if the user does not have any access tokens.</p></dd> <p>The currently elected beta codec, as determined by the server through a majority vote.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSUInteger)betaCodec</code></div> - + + @@ -635,9 +652,11 @@ This parameter may be nil if the user does not have any access tokens.</p></dd> <p>Returns the certificate chain that is to be presented to the server during the next connection attempt.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSArray *)certificateChain</code></div> - + + @@ -669,9 +688,11 @@ This parameter may be nil if the user does not have any access tokens.</p></dd> <p>Establish a connection to the given host and <a href="#//api/name/port">port</a>.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)connectToHost:(NSString *)<em>hostName</em> port:(NSUInteger)<em>port</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -718,9 +739,11 @@ This parameter may be nil if the user does not have any access tokens.</p></dd> <p>The current status of the connection.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (BOOL)connected</code></div> - + + @@ -758,9 +781,11 @@ Returns NO otherwise.</p> <p>Deallocate a MKConnection object.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)dealloc</code></div> - + + @@ -792,9 +817,11 @@ Returns NO otherwise.</p> <p>Disconnect from the server.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)disconnect</code></div> - + + @@ -826,9 +853,11 @@ Returns NO otherwise.</p> <p>Returns the current Forced-TCP status of the MKConnection object.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (BOOL)forceTCP</code></div> - + + @@ -866,9 +895,11 @@ is being tunelled through a TCP connection. Returns NO otherwise.</p> <p>The hostname that the MKConnection is currently <a href="#//api/name/connected">connected</a> to.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSString *)hostname</code></div> - + + @@ -900,9 +931,11 @@ is being tunelled through a TCP connection. Returns NO otherwise.</p> <p>Initialize a new MKConnection object.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (id)init</code></div> - + + @@ -936,9 +969,11 @@ trust status of the server’s certificate chain. This trust is based on the system’s list of root certificate authorities.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (BOOL)peerCertificateChainTrusted</code></div> - + + @@ -971,9 +1006,11 @@ on the system’s list of root certificate authorities.</p> containing the TLS certificate chain of the remote server.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSArray *)peerCertificates</code></div> - + + @@ -1010,9 +1047,11 @@ containing the TLS certificate chain of the remote server.</p> <p>The port number on the host that the MKConnection is currently <a href="#//api/name/connected">connected</a> to.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSUInteger)port</code></div> - + + @@ -1045,9 +1084,11 @@ containing the TLS certificate chain of the remote server.</p> all possible).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (BOOL)preferAlphaCodec</code></div> - + + @@ -1081,9 +1122,11 @@ all possible).</p> for self-signed certificates.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)reconnect</code></div> - + + @@ -1117,9 +1160,11 @@ the Mumble server) using the given messageType as the token used for identifying how the contents of the message are to be handled by the remote server.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)sendMessageWithType:(MKMessageType)<em>messageType</em> data:(NSData *)<em>data</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1172,9 +1217,11 @@ the <a href="#//api/name/forceTCP">forceTCP</a> property has been changed to for tunelled through TCP.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)sendVoiceData:(NSData *)<em>data</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1217,9 +1264,11 @@ tunelled through TCP.</p> MKConnection object is currently <a href="#//api/name/connected">connected</a> to.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSString *)serverOSName</code></div> - + + @@ -1252,9 +1301,11 @@ MKConnection object is currently <a href="#//api/name/connected">connected</a> t server that the MKConnection object is currently <a href="#//api/name/connected">connected</a> to.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSString *)serverOSVersion</code></div> - + + @@ -1287,9 +1338,11 @@ server that the MKConnection object is currently <a href="#//api/name/connected" object is currently <a href="#//api/name/connected">connected</a> to.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSString *)serverRelease</code></div> - + + @@ -1322,9 +1375,11 @@ object is currently <a href="#//api/name/connected">connected</a> to.</p> object is currently <a href="#//api/name/connected">connected</a> to.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSString *)serverVersion</code></div> - + + @@ -1358,9 +1413,11 @@ used during connection establishment, and as such, chaning this value while the MKConnection object is a conncted to a server has no effect.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)setCertificateChain:(NSArray *)<em>chain</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1404,9 +1461,11 @@ through TCP. If at all possible, this should be kept as NO (which is also the default value).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)setForceTCP:(BOOL)<em>shouldForceTCP</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1451,9 +1510,11 @@ errors that happen while verifying the server’s certificate chain during the TLS handshake.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)setIgnoreSSLVerification:(BOOL)<em>shouldIgnoreVerification</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1493,6 +1554,42 @@ errors. By default this is set to NO.</p></dd> </div> + <div class="section-method"> + <a name="//api/name/shouldUseOpus" title="shouldUseOpus"></a> + <h3 class="subsubtitle method-title">shouldUseOpus</h3> + + + + <div class="method-subsection brief-description"> + <p>Returns whether ot not the <a href="#//api/name/connected">connected</a> client should use the Opus codec.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (BOOL)shouldUseOpus</code></div> + + + + + + + + + + + + + + + + <div class="method-subsection declared-in-section"> + <h4 class="method-subtitle">Declared In</h4> + <code class="declared-in-ref">MKConnection.h</code><br /> + </div> + + +</div> + </div> @@ -1506,9 +1603,9 @@ errors. By default this is set to NO.</p></dd> <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-05-03)</span><br /> + <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-10-19)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 774)</a>.</span></p> + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 840)</a>.</span></p> </div> </div> @@ -1596,6 +1693,14 @@ errors. By default this is set to NO.</p></dd> } window.onload = init; + + // If showing in Xcode, hide the TOC and Header + if (navigator.userAgent.match(/xcode/i)) { + document.getElementById("contents").className = "hideInXcode" + document.getElementById("tocContainer").className = "hideInXcode" + document.getElementById("top_header").className = "hideInXcode" + } + </script> </body> </html>
\ No newline at end of file diff --git a/Classes/MKConnectionController.html b/Classes/MKConnectionController.html index 27d541a..24ba05f 100644 --- a/Classes/MKConnectionController.html +++ b/Classes/MKConnectionController.html @@ -7,7 +7,7 @@ <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.5 (build 774)" /> + <meta name="generator" content="appledoc 2.1 (build 840)" /> </head> <body> <header id="top_header"> @@ -212,9 +212,11 @@ to the array are not currently handled.</p></span> <p>Get this process’s instance of MKConnectionController.</p> </div> - + + <div class="method-subsection method-declaration"><code>+ (MKConnectionController *)sharedController</code></div> - + + @@ -255,9 +257,11 @@ to the array are not currently handled.</p></span> Note: This will be removed sooner or later, as it should not be part of the controller’s public API.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)addConnection:(MKConnection *)<em>conn</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -301,9 +305,11 @@ This way of accessing connections is very fragile, since concurrent access to the array are not currently handled.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSArray *)allConnections</code></div> - + + @@ -336,9 +342,11 @@ to the array are not currently handled.</p> Note: This will be removed sooner or later, as it should not be part of the controller’s public API.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)removeConnection:(MKConnection *)<em>conn</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -383,9 +391,9 @@ 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">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-05-03)</span><br /> + <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-10-19)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 774)</a>.</span></p> + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 840)</a>.</span></p> </div> </div> @@ -473,6 +481,14 @@ Note: This will be removed sooner or later, as it should not be part of the cont } window.onload = init; + + // If showing in Xcode, hide the TOC and Header + if (navigator.userAgent.match(/xcode/i)) { + document.getElementById("contents").className = "hideInXcode" + document.getElementById("tocContainer").className = "hideInXcode" + document.getElementById("top_header").className = "hideInXcode" + } + </script> </body> </html>
\ No newline at end of file diff --git a/Classes/MKRSAKeyPair.html b/Classes/MKRSAKeyPair.html index 6f6f348..638fa2f 100644 --- a/Classes/MKRSAKeyPair.html +++ b/Classes/MKRSAKeyPair.html @@ -7,7 +7,7 @@ <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.5 (build 774)" /> + <meta name="generator" content="appledoc 2.1 (build 840)" /> </head> <body> <header id="top_header"> @@ -165,9 +165,11 @@ performed asynchronously on a distinct dispatch queue. If no delegate is provide is performed in the context in which the method is called.</p> </div> - + + <div class="method-subsection method-declaration"><code>+ (MKRSAKeyPair *)generateKeyPairOfSize:(NSUInteger)<em>bits</em> withDelegate:(id<MKRSAKeyPairDelegate>)<em>delegate</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -227,9 +229,9 @@ and call the delegate on the main thread.</p></dd> <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-05-03)</span><br /> + <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-10-19)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 774)</a>.</span></p> + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 840)</a>.</span></p> </div> </div> @@ -317,6 +319,14 @@ and call the delegate on the main thread.</p></dd> } window.onload = init; + + // If showing in Xcode, hide the TOC and Header + if (navigator.userAgent.match(/xcode/i)) { + document.getElementById("contents").className = "hideInXcode" + document.getElementById("tocContainer").className = "hideInXcode" + document.getElementById("top_header").className = "hideInXcode" + } + </script> </body> </html>
\ No newline at end of file diff --git a/Classes/MKServerModel.html b/Classes/MKServerModel.html index 79536c5..ec62cfd 100644 --- a/Classes/MKServerModel.html +++ b/Classes/MKServerModel.html @@ -7,7 +7,7 @@ <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.5 (build 774)" /> + <meta name="generator" content="appledoc 2.1 (build 840)" /> </head> <body> <header id="top_header"> @@ -50,6 +50,8 @@ <option value="//api/name/connectedUser"> - connectedUser</option> + <option value="//api/name/createChannelWithName:parent:temporary:"> - createChannelWithName:parent:temporary:</option> + <option value="//api/name/hostname"> - hostname</option> <option value="//api/name/initWithConnection:"> - initWithConnection:</option> @@ -62,6 +64,8 @@ <option value="//api/name/removeDelegate:"> - removeDelegate:</option> + <option value="//api/name/requestAccessControlForChannel:"> - requestAccessControlForChannel:</option> + <option value="//api/name/rootChannel"> - rootChannel</option> <option value="//api/name/sendTextMessage:toChannel:"> - sendTextMessage:toChannel:</option> @@ -76,6 +80,8 @@ <option value="//api/name/serverCertificatesTrusted"> - serverCertificatesTrusted</option> + <option value="//api/name/setAccessControl:forChannel:"> - setAccessControl:forChannel:</option> + <option value="//api/name/setAccessTokens:"> - setAccessTokens:</option> <option value="//api/name/userWithHash:"> - userWithHash:</option> @@ -132,6 +138,8 @@ <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/createChannelWithName:parent:temporary:">createChannelWithName:parent:temporary:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/hostname">hostname</a></span></li> <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithConnection:">initWithConnection:</a></span></li> @@ -144,6 +152,8 @@ <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/requestAccessControlForChannel:">requestAccessControlForChannel:</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/sendTextMessage:toChannel:">sendTextMessage:toChannel:</a></span></li> @@ -158,6 +168,8 @@ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverCertificatesTrusted">serverCertificatesTrusted</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setAccessControl:forChannel:">setAccessControl:forChannel:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/setAccessTokens:">setAccessTokens:</a></span></li> <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/userWithHash:">userWithHash:</a></span></li> @@ -332,6 +344,28 @@ connected to.</p></span> </span> +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/createChannelWithName:parent:temporary:">– createChannelWithName:parent:temporary:</a></code> + <span class="tooltip"><p>Create a new channel in 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/requestAccessControlForChannel:">– requestAccessControlForChannel:</a></code> + <span class="tooltip"><p>Ask the underlying connection to receive the access control for the given channel.</p></span> + </span> + + +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/setAccessControl:forChannel:">– setAccessControl:forChannel:</a></code> + <span class="tooltip"><p>Set access control for a channel.</p></span> + </span> + + </li> </ul> @@ -440,9 +474,11 @@ connected to.</p></span> <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> @@ -484,9 +520,11 @@ connected to.</p></span> <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> @@ -528,10 +566,69 @@ connected to.</p></span> <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/createChannelWithName:parent:temporary:" title="createChannelWithName:parent:temporary:"></a> + <h3 class="subsubtitle method-title">createChannelWithName:parent:temporary:</h3> + + <div class="method-subsection brief-description"> + <p>Create a new channel in the server the underlying <a href="../Classes/MKConnection.html">MKConnection</a> is currently +connected to.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (void)createChannelWithName:(NSString *)<em>channelName</em> parent:(MKChannel *)<em>parent</em> temporary:(BOOL)<em>temp</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>channelName</em></dt> + <dd><p>The name of the channel to create.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>parent</em></dt> + <dd><p>The <a href="../Classes/MKChannel.html">MKChannel</a> that must contain the newly created one.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>temp</em></dt> + <dd><p>Specify if the channel is temporary or not.</p></dd> + </dl> + + </div> + @@ -562,9 +659,11 @@ connected to.</p></span> <p>Returns the hostname of the server that the MKServerModel is currently connected to.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSString *)hostname</code></div> - + + @@ -596,9 +695,11 @@ connected to.</p></span> <p>Initialize a MKServerModel 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> @@ -640,9 +741,11 @@ connected to.</p></span> <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> @@ -684,9 +787,11 @@ connected to.</p></span> <p>Returns the port of the server that the MKServerModel is currently connected to.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSInteger)port</code></div> - + + @@ -718,9 +823,11 @@ connected to.</p></span> <p>Registers the currently connected user with the server.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)registerConnectedUser</code></div> - + + @@ -752,9 +859,11 @@ connected to.</p></span> <p>Remove a delegate from the MKServerModel.</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> @@ -787,6 +896,52 @@ connected to.</p></span> </div> <div class="section-method"> + <a name="//api/name/requestAccessControlForChannel:" title="requestAccessControlForChannel:"></a> + <h3 class="subsubtitle method-title">requestAccessControlForChannel:</h3> + + + + <div class="method-subsection brief-description"> + <p>Ask the underlying connection to receive the access control for the given channel.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (void)requestAccessControlForChannel:(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 for which you are requesting the access control.</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> @@ -797,9 +952,11 @@ connected to.</p></span> connected to.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (MKChannel *)rootChannel</code></div> - + + @@ -836,9 +993,11 @@ connected to.</p> <p>Send a message to all users in the the channel chan.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)sendTextMessage:(MKTextMessage *)<em>txtMsg</em> toChannel:(MKChannel *)<em>chan</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -886,9 +1045,11 @@ connected to.</p> (subchannels, children of subchannels, and so on).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)sendTextMessage:(MKTextMessage *)<em>txtMsg</em> toTree:(MKChannel *)<em>chan</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -935,9 +1096,11 @@ connected to.</p> <p>Send a text message to the given destinations.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)sendTextMessage:(MKTextMessage *)<em>txtMsg</em> toTreeChannels:(NSArray *)<em>trees</em> andChannels:(NSArray *)<em>channels</em> andUsers:(NSArray *)<em>users</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1006,9 +1169,11 @@ specifically targetted at them.</p> <p>Send a message to the user user.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)sendTextMessage:(MKTextMessage *)<em>txtMsg</em> toUser:(MKUser *)<em>user</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1055,9 +1220,11 @@ specifically targetted at them.</p> <p>Get the server’s certificate chain.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSArray *)serverCertificates</code></div> - + + @@ -1089,8 +1256,11 @@ specifically targetted at them.</p> <p>Get whether or not the certificate chain is verified by the system’s root CAs.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (BOOL)serverCertificatesTrusted</code></div> + + @@ -1104,6 +1274,56 @@ specifically targetted at them.</p> + <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/setAccessControl:forChannel:" title="setAccessControl:forChannel:"></a> + <h3 class="subsubtitle method-title">setAccessControl:forChannel:</h3> + + + + <div class="method-subsection brief-description"> + <p>Set access control for a channel.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (void)setAccessControl:(MKAccessControl *)<em>accessControl</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>channel</em></dt> + <dd><p>The channel for which you are setting the access control.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>acl</em></dt> + <dd><p>The access control you want to set.</p></dd> + </dl> + + </div> + + + + + + + + + + + + <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> @@ -1123,9 +1343,11 @@ specifically targetted at them.</p> <p>Set the list of access tokens for the currently connected user.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)setAccessTokens:(NSArray *)<em>tokens</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1169,9 +1391,11 @@ connected user.</p></dd> 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> @@ -1219,9 +1443,11 @@ does not exist on the server.</p> <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> @@ -1272,9 +1498,9 @@ if the user does not exist on the server.</p> <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-05-03)</span><br /> + <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-10-19)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 774)</a>.</span></p> + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 840)</a>.</span></p> </div> </div> @@ -1362,6 +1588,14 @@ if the user does not exist on the server.</p> } window.onload = init; + + // If showing in Xcode, hide the TOC and Header + if (navigator.userAgent.match(/xcode/i)) { + document.getElementById("contents").className = "hideInXcode" + document.getElementById("tocContainer").className = "hideInXcode" + document.getElementById("top_header").className = "hideInXcode" + } + </script> </body> </html>
\ No newline at end of file diff --git a/Classes/MKServerPinger.html b/Classes/MKServerPinger.html index 4a0b4af..5aab926 100644 --- a/Classes/MKServerPinger.html +++ b/Classes/MKServerPinger.html @@ -7,7 +7,7 @@ <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.5 (build 774)" /> + <meta name="generator" content="appledoc 2.1 (build 840)" /> </head> <body> <header id="top_header"> @@ -192,9 +192,11 @@ when the remote server responds to a ping request.</p></span> <p>Returns the currently-set delegate for the MKServerPinger object.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (id<MKServerPingerDelegate>)delegate</code></div> - + + @@ -232,9 +234,11 @@ when the remote server responds to a ping request.</p></span> 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> @@ -288,9 +292,11 @@ register a <a href="#//api/name/delegate">delegate</a> implementing the <a href= 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> @@ -336,9 +342,9 @@ Must implement the <a href="../Protocols/MKServerPingerDelegate.html">MKServerPi <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-05-03)</span><br /> + <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-10-19)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 774)</a>.</span></p> + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 840)</a>.</span></p> </div> </div> @@ -426,6 +432,14 @@ Must implement the <a href="../Protocols/MKServerPingerDelegate.html">MKServerPi } window.onload = init; + + // If showing in Xcode, hide the TOC and Header + if (navigator.userAgent.match(/xcode/i)) { + document.getElementById("contents").className = "hideInXcode" + document.getElementById("tocContainer").className = "hideInXcode" + document.getElementById("top_header").className = "hideInXcode" + } + </script> </body> </html>
\ No newline at end of file diff --git a/Classes/MKServices.html b/Classes/MKServices.html index 62388e8..117c836 100644 --- a/Classes/MKServices.html +++ b/Classes/MKServices.html @@ -7,7 +7,7 @@ <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.5 (build 774)" /> + <meta name="generator" content="appledoc 2.1 (build 840)" /> </head> <body> <header id="top_header"> @@ -184,9 +184,11 @@ Mumble services.</p> <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> - + + @@ -218,9 +220,11 @@ Mumble services.</p> <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> - + + @@ -252,9 +256,11 @@ Mumble services.</p> <p>Get the hostname of the closest regional services host.</p> </div> - + + <div class="method-subsection method-declaration"><code>+ (NSString *)regionalServicesHost</code></div> - + + @@ -291,9 +297,9 @@ Mumble services.</p> <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-05-03)</span><br /> + <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-10-19)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 774)</a>.</span></p> + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 840)</a>.</span></p> </div> </div> @@ -381,6 +387,14 @@ Mumble services.</p> } window.onload = init; + + // If showing in Xcode, hide the TOC and Header + if (navigator.userAgent.match(/xcode/i)) { + document.getElementById("contents").className = "hideInXcode" + document.getElementById("tocContainer").className = "hideInXcode" + document.getElementById("top_header").className = "hideInXcode" + } + </script> </body> </html>
\ No newline at end of file diff --git a/Classes/MKTextMessage.html b/Classes/MKTextMessage.html index a353151..31a77bb 100644 --- a/Classes/MKTextMessage.html +++ b/Classes/MKTextMessage.html @@ -7,7 +7,7 @@ <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.5 (build 774)" /> + <meta name="generator" content="appledoc 2.1 (build 840)" /> </head> <body> <header id="top_header"> @@ -227,9 +227,11 @@ considered valid).</p></span> <p>Create a new MKTextMessage with HTML representation given in html.</p> </div> - + + <div class="method-subsection method-declaration"><code>+ (MKTextMessage *)messageWithHTML:(NSString *)<em>html</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -278,9 +280,11 @@ considered valid).</p></span> msg.</p> </div> - + + <div class="method-subsection method-declaration"><code>+ (MKTextMessage *)messageWithPlainText:(NSString *)<em>msg</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -329,9 +333,11 @@ msg.</p> is chosen depending on the content of the message.</p> </div> - + + <div class="method-subsection method-declaration"><code>+ (MKTextMessage *)messageWithString:(NSString *)<em>str</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -389,9 +395,11 @@ itself and handle the message accordingly.</p></dd> <p>Returns an HTML representation of the text message.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSString *)HTMLString</code></div> - + + @@ -430,9 +438,11 @@ version, a plain text version is returned.</p> considered valid).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSArray *)embeddedImages</code></div> - + + @@ -470,9 +480,11 @@ represented as data URIs.</p> <p>Returns all links found in the text message.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSArray *)embeddedLinks</code></div> - + + @@ -512,9 +524,11 @@ an HTML formatted message, the formatting will be stripped, and a plain text string will be returned.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSString *)plainTextString</code></div> - + + @@ -556,9 +570,9 @@ is an HTML message, it will be lossily converted to plain text.</p> <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-05-03)</span><br /> + <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-10-19)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 774)</a>.</span></p> + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 840)</a>.</span></p> </div> </div> @@ -646,6 +660,14 @@ is an HTML message, it will be lossily converted to plain text.</p> } window.onload = init; + + // If showing in Xcode, hide the TOC and Header + if (navigator.userAgent.match(/xcode/i)) { + document.getElementById("contents").className = "hideInXcode" + document.getElementById("tocContainer").className = "hideInXcode" + document.getElementById("top_header").className = "hideInXcode" + } + </script> </body> </html>
\ No newline at end of file diff --git a/Classes/MKUser.html b/Classes/MKUser.html index df04209..a9c9a6f 100644 --- a/Classes/MKUser.html +++ b/Classes/MKUser.html @@ -7,7 +7,7 @@ <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.5 (build 774)" /> + <meta name="generator" content="appledoc 2.1 (build 840)" /> </head> <body> <header id="top_header"> @@ -392,9 +392,11 @@ in either JPEG, PNG or ARGB32 format.</p></span> <p>Returns the channel that the receiving user is currently residing in.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (MKChannel *)channel</code></div> - + + @@ -426,9 +428,11 @@ in either JPEG, PNG or ARGB32 format.</p></span> <p>Return the user’s current comment as an NSString.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSString *)comment</code></div> - + + @@ -460,9 +464,11 @@ in either JPEG, PNG or ARGB32 format.</p></span> <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> - + + @@ -494,9 +500,11 @@ in either JPEG, PNG or ARGB32 format.</p></span> <p>Returns whether or not the user is authenticated.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (BOOL)isAuthenticated</code></div> - + + @@ -528,9 +536,11 @@ in either JPEG, PNG or ARGB32 format.</p></span> <p>Returns whether or not the receiving user is deafened.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (BOOL)isDeafened</code></div> - + + @@ -562,9 +572,11 @@ in either JPEG, PNG or ARGB32 format.</p></span> <p>Returns whether or not the receiving user is a friend.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (BOOL)isFriend</code></div> - + + @@ -596,9 +608,11 @@ in either JPEG, PNG or ARGB32 format.</p></span> <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> - + + @@ -630,9 +644,11 @@ in either JPEG, PNG or ARGB32 format.</p></span> <p>Returns whether or not the receiving user is muted.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (BOOL)isMuted</code></div> - + + @@ -664,9 +680,11 @@ in either JPEG, PNG or ARGB32 format.</p></span> <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> - + + @@ -698,9 +716,11 @@ in either JPEG, PNG or ARGB32 format.</p></span> <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> - + + @@ -732,9 +752,11 @@ in either JPEG, PNG or ARGB32 format.</p></span> <p>Returns whether or not the receiving user is self-deafened.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (BOOL)isSelfDeafened</code></div> - + + @@ -766,9 +788,11 @@ in either JPEG, PNG or ARGB32 format.</p></span> <p>Returns whether or not the receiving user is self-muted.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (BOOL)isSelfMuted</code></div> - + + @@ -800,9 +824,11 @@ in either JPEG, PNG or ARGB32 format.</p></span> <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> - + + @@ -837,9 +863,11 @@ 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> - + + @@ -871,9 +899,11 @@ is registered with the server.</p> <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> - + + @@ -907,9 +937,11 @@ contains the binary representation of the user’s texture as an image in either JPEG, PNG or ARGB32 format.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSData *)texture</code></div> - + + @@ -941,9 +973,11 @@ in either JPEG, PNG or ARGB32 format.</p> <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> - + + @@ -976,9 +1010,11 @@ in either JPEG, PNG or ARGB32 format.</p> certificate, but could be any unique hash that identifies the user.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSString *)userHash</code></div> - + + @@ -1012,9 +1048,11 @@ 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> - + + @@ -1046,9 +1084,11 @@ A user ID of 0 signals that the user is the SuperUser.</p> <p>Returns the user’s username.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (NSString *)userName</code></div> - + + @@ -1083,9 +1123,9 @@ A user ID of 0 signals that the user is the SuperUser.</p> <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-05-03)</span><br /> + <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-10-19)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 774)</a>.</span></p> + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 840)</a>.</span></p> </div> </div> @@ -1173,6 +1213,14 @@ A user ID of 0 signals that the user is the SuperUser.</p> } window.onload = init; + + // If showing in Xcode, hide the TOC and Header + if (navigator.userAgent.match(/xcode/i)) { + document.getElementById("contents").className = "hideInXcode" + document.getElementById("tocContainer").className = "hideInXcode" + document.getElementById("top_header").className = "hideInXcode" + } + </script> </body> </html>
\ No newline at end of file diff --git a/Protocols/MKConnectionDelegate.html b/Protocols/MKConnectionDelegate.html index 17a74bf..f781f35 100644 --- a/Protocols/MKConnectionDelegate.html +++ b/Protocols/MKConnectionDelegate.html @@ -7,7 +7,7 @@ <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.5 (build 774)" /> + <meta name="generator" content="appledoc 2.1 (build 840)" /> </head> <body> <header id="top_header"> @@ -126,7 +126,7 @@ <div class="section section-overview"> <a title="Overview" name="overview"></a> <h2 class="subtitle subtitle-overview">Overview</h2> - <p><a href="MKConnectionDelegate.html">MKConnectionDelegate</a> implements a set of methods that are called on the delegate + <p>MKConnectionDelegate implements a set of methods that are called on the delegate object of a <a href="../Classes/MKConnection.html">MKConnection</a> when important connection-related events happen.</p> </div> @@ -213,9 +213,11 @@ disconnection. If the disconnection was caused by an error, the err parameter wi be a non-nil value.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)connection:(MKConnection *)<em>conn</em> closedWithError:(NSError *)<em>err</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -269,9 +271,11 @@ called instead.</p> <p>The connection attempt was rejected. This could, for example, be an authentication failure.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)connection:(MKConnection *)<em>conn</em> rejectedWithReason:(MKRejectReason)<em>reason</em> explanation:(NSString *)<em>explanation</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -324,9 +328,11 @@ called instead.</p> of the remote server as trusted.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)connection:(MKConnection *)<em>conn</em> trustFailureInCertificateChain:(NSArray *)<em>chain</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -384,9 +390,11 @@ reconnect to the <a href="../Classes/MKConnection.html">MKConnection</a> object. <p>This method is called if a connection cannot be stablished to the given server.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)connection:(MKConnection *)<em>conn</em> unableToConnectWithError:(NSError *)<em>err</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -436,9 +444,11 @@ Once the <a href="../Classes/MKConnection.html">MKConnection</a> has sent this m with the server.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)connectionOpened:(MKConnection *)<em>conn</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -483,9 +493,9 @@ with the server.</p> <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-05-03)</span><br /> + <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-10-19)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 774)</a>.</span></p> + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 840)</a>.</span></p> </div> </div> @@ -573,6 +583,14 @@ with the server.</p> } window.onload = init; + + // If showing in Xcode, hide the TOC and Header + if (navigator.userAgent.match(/xcode/i)) { + document.getElementById("contents").className = "hideInXcode" + document.getElementById("tocContainer").className = "hideInXcode" + document.getElementById("top_header").className = "hideInXcode" + } + </script> </body> </html>
\ No newline at end of file diff --git a/Protocols/MKMessageHandler.html b/Protocols/MKMessageHandler.html index b4f2328..0a2abf4 100644 --- a/Protocols/MKMessageHandler.html +++ b/Protocols/MKMessageHandler.html @@ -7,7 +7,7 @@ <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.5 (build 774)" /> + <meta name="generator" content="appledoc 2.1 (build 840)" /> </head> <body> <header id="top_header"> @@ -166,7 +166,7 @@ <div class="section section-overview"> <a title="Overview" name="overview"></a> <h2 class="subtitle subtitle-overview">Overview</h2> - <p><a href="MKMessageHandler.html">MKMessageHandler</a> implements a set of methods that are called on the messageHandler + <p>MKMessageHandler implements a set of methods that are called on the messageHandler object of a <a href="../Classes/MKConnection.html">MKConnection</a> when new control channel messages arrive. Only messages that the <a href="../Classes/MKConnection.html">MKConnection</a> itself does not know how to handle are delegated to the messageHandler.</p> @@ -332,9 +332,11 @@ VoiceTargetMessage value).</p></span> <p>Called whenever an ACL message is receieved. (See MKMessageType’s ACLMessage value).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)connection:(MKConnection *)<em>conn</em> handleACLMessage:(id)<em>msg</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -382,9 +384,11 @@ VoiceTargetMessage value).</p></span> BanListMessage value).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)connection:(MKConnection *)<em>conn</em> handleBanListMessage:(id)<em>msg</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -432,9 +436,11 @@ BanListMessage value).</p> ChannelRemoveMessage value).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)connection:(MKConnection *)<em>conn</em> handleChannelRemoveMessage:(id)<em>msg</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -482,9 +488,11 @@ ChannelRemoveMessage value).</p> ChannelStateMessage value).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)connection:(MKConnection *)<em>conn</em> handleChannelStateMessage:(id)<em>msg</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -532,9 +540,11 @@ ChannelStateMessage value).</p> ContextActionMessage value).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)connection:(MKConnection *)<em>conn</em> handleContextActionMessage:(id)<em>msg</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -582,9 +592,11 @@ ContextActionMessage value).</p> ContextActionModify value).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)connection:(MKConnection *)<em>conn</em> handleContextActionModifyMessage:(id)<em>msg</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -632,9 +644,11 @@ ContextActionModify value).</p> PermissionDeniedMessage value).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)connection:(MKConnection *)<em>conn</em> handlePermissionDeniedMessage:(id)<em>msg</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -681,9 +695,11 @@ PermissionDeniedMessage value).</p> <p>Called whenever a permission query message is receieved.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)connection:(MKConnection *)<em>conn</em> handlePermissionQueryMessage:(id)<em>msg</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -731,9 +747,11 @@ PermissionDeniedMessage value).</p> QueryUsersMessage value).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)connection:(MKConnection *)<em>conn</em> handleQueryUsersMessage:(id)<em>msg</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -781,9 +799,11 @@ QueryUsersMessage value).</p> ServerSyncMessage value).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)connection:(MKConnection *)<em>conn</em> handleServerSyncMessage:(id)<em>msg</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -831,9 +851,11 @@ ServerSyncMessage value).</p> TextMessageMessage value).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)connection:(MKConnection *)<em>conn</em> handleTextMessageMessage:(id)<em>msg</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -881,9 +903,11 @@ TextMessageMessage value).</p> UserListMessage value).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)connection:(MKConnection *)<em>conn</em> handleUserListMessage:(id)<em>msg</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -931,9 +955,11 @@ UserListMessage value).</p> UserRemoveMessage value).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)connection:(MKConnection *)<em>conn</em> handleUserRemoveMessage:(id)<em>msg</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -981,9 +1007,11 @@ UserRemoveMessage value).</p> UserStateMessage value).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)connection:(MKConnection *)<em>conn</em> handleUserStateMessage:(id)<em>msg</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1031,9 +1059,11 @@ UserStateMessage value).</p> VoiceTargetMessage value).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)connection:(MKConnection *)<em>conn</em> handleVoiceTargetMessage:(id)<em>msg</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1083,9 +1113,9 @@ VoiceTargetMessage value).</p> <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-05-03)</span><br /> + <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-10-19)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 774)</a>.</span></p> + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 840)</a>.</span></p> </div> </div> @@ -1173,6 +1203,14 @@ VoiceTargetMessage value).</p> } window.onload = init; + + // If showing in Xcode, hide the TOC and Header + if (navigator.userAgent.match(/xcode/i)) { + document.getElementById("contents").className = "hideInXcode" + document.getElementById("tocContainer").className = "hideInXcode" + document.getElementById("top_header").className = "hideInXcode" + } + </script> </body> </html>
\ No newline at end of file diff --git a/Protocols/MKRSAKeyPairDelegate.html b/Protocols/MKRSAKeyPairDelegate.html index a706fd6..f5b5fa8 100644 --- a/Protocols/MKRSAKeyPairDelegate.html +++ b/Protocols/MKRSAKeyPairDelegate.html @@ -7,7 +7,7 @@ <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.5 (build 774)" /> + <meta name="generator" content="appledoc 2.1 (build 840)" /> </head> <body> <header id="top_header"> @@ -161,9 +161,11 @@ public and private key.</p> <p>Called when an <a href="../Classes/MKRSAKeyPair.html">MKRSAKeyPair</a> has finished generating its RSA key pair.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)rsaKeyPairDidFinishGenerating:(MKRSAKeyPair *)<em>keyPair</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -208,9 +210,9 @@ public and private key.</p> <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-05-03)</span><br /> + <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-10-19)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 774)</a>.</span></p> + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 840)</a>.</span></p> </div> </div> @@ -298,6 +300,14 @@ public and private key.</p> } window.onload = init; + + // If showing in Xcode, hide the TOC and Header + if (navigator.userAgent.match(/xcode/i)) { + document.getElementById("contents").className = "hideInXcode" + document.getElementById("tocContainer").className = "hideInXcode" + document.getElementById("top_header").className = "hideInXcode" + } + </script> </body> </html>
\ No newline at end of file diff --git a/Protocols/MKServerModelDelegate.html b/Protocols/MKServerModelDelegate.html index 7023e9a..357bc71 100644 --- a/Protocols/MKServerModelDelegate.html +++ b/Protocols/MKServerModelDelegate.html @@ -7,7 +7,7 @@ <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.5 (build 774)" /> + <meta name="generator" content="appledoc 2.1 (build 840)" /> </head> <body> <header id="top_header"> @@ -56,6 +56,8 @@ <option value="//api/name/serverModel:channelRenamed:"> - serverModel:channelRenamed:</option> + <option value="//api/name/serverModel:didReceiveAccessControl:forChannel:"> - serverModel:didReceiveAccessControl:forChannel:</option> + <option value="//api/name/serverModel:invalidUsernameErrorForName:"> - serverModel:invalidUsernameErrorForName:</option> <option value="//api/name/serverModel:joinedServerAsUser:"> - serverModel:joinedServerAsUser:</option> @@ -136,6 +138,8 @@ <option value="//api/name/serverModelChannelFullError:"> - serverModelChannelFullError:</option> + <option value="//api/name/serverModelChannelNameError:"> - serverModelChannelNameError:</option> + <option value="//api/name/serverModelDisconnected:"> - serverModelDisconnected:</option> <option value="//api/name/serverModelInvalidChannelNameError:"> - serverModelInvalidChannelNameError:</option> @@ -204,6 +208,8 @@ <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:didReceiveAccessControl:forChannel:">serverModel:didReceiveAccessControl:forChannel:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:invalidUsernameErrorForName:">serverModel:invalidUsernameErrorForName:</a></span></li> <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModel:joinedServerAsUser:">serverModel:joinedServerAsUser:</a></span></li> @@ -284,6 +290,8 @@ <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModelChannelFullError:">serverModelChannelFullError:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModelChannelNameError:">serverModelChannelNameError:</a></span></li> + <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModelDisconnected:">serverModelDisconnected:</a></span></li> <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/serverModelInvalidChannelNameError:">serverModelInvalidChannelNameError:</a></span></li> @@ -328,7 +336,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 <a href="../Classes/MKServerModel.html">MKServerModel</a>. + <p>MKServerModelDelegate 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> @@ -775,6 +783,14 @@ channel was full. (Note: A joinChannel: also counts as a move operation.)</p></s </li><li> <span class="tooltip"> + <code><a href="#//api/name/serverModelChannelNameError:">– serverModelChannelNameError:</a></code> + <span class="tooltip"><p>Called when a channel create operation failed because the channel +name was invalid.</p></span> + </span> + + +</li><li> + <span class="tooltip"> <code><a href="#//api/name/serverModel:permissionDeniedForReason:">– serverModel:permissionDeniedForReason:</a></code> <span class="tooltip"><p>Called when a simple ‘Permission denied.’ message is sufficient to show to the user. Can include a reason. This kind of permission error is also used as a fallback, if @@ -783,6 +799,13 @@ to understand all error types.</p></span> </span> +</li><li> + <span class="tooltip"> + <code><a href="#//api/name/serverModel:didReceiveAccessControl:forChannel:">– serverModel:didReceiveAccessControl:forChannel:</a></code> + <span class="tooltip"><p>Called after an access control request</p></span> + </span> + + </li> </ul> @@ -810,9 +833,11 @@ to understand all error types.</p></span> <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> @@ -859,9 +884,11 @@ to understand all error types.</p></span> <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> @@ -908,9 +935,11 @@ to understand all error types.</p></span> <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> @@ -957,9 +986,11 @@ to understand all error types.</p></span> <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> @@ -1006,9 +1037,11 @@ to understand all error types.</p></span> <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> @@ -1055,9 +1088,11 @@ to understand all error types.</p></span> <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> @@ -1095,6 +1130,62 @@ to understand all error types.</p></span> </div> <div class="section-method"> + <a name="//api/name/serverModel:didReceiveAccessControl:forChannel:" title="serverModel:didReceiveAccessControl:forChannel:"></a> + <h3 class="subsubtitle method-title">serverModel:didReceiveAccessControl:forChannel:</h3> + + + + <div class="method-subsection brief-description"> + <p>Called after an access control request</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> didReceiveAccessControl:(MKAccessControl *)<em>accessControl</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>accessControl</em></dt> + <dd><p>The requested access control.</p></dd> + </dl> + + <dl class="argument-def parameter-def"> + <dt><em>channel</em></dt> + <dd><p>The channel to which access control refers.</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:invalidUsernameErrorForName:" title="serverModel:invalidUsernameErrorForName:"></a> <h3 class="subsubtitle method-title">serverModel:invalidUsernameErrorForName:</h3> @@ -1104,9 +1195,11 @@ to understand all error types.</p></span> <p>Called when an action involving an invalid username occurs.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> invalidUsernameErrorForName:(NSString *)<em>name</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1154,9 +1247,11 @@ to understand all error types.</p></span> This method is deprecated, see <a href="#//api/name/serverModel:joinedServerAsUser:withWelcomeMessage:">serverModel:joinedServerAsUser:withWelcomeMessage:</a>.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> joinedServerAsUser:(MKUser *)<em>user</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1203,9 +1298,11 @@ This method is deprecated, see <a href="#//api/name/serverModel:joinedServerAsUs <p>Called upon successfully authenticating with a server.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> joinedServerAsUser:(MKUser *)<em>user</em> withWelcomeMessage:(MKTextMessage *)<em>msg</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1257,9 +1354,11 @@ This method is deprecated, see <a href="#//api/name/serverModel:joinedServerAsUs <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> @@ -1311,9 +1410,11 @@ This method is deprecated, see <a href="#//api/name/serverModel:joinedServerAsUs <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> @@ -1360,9 +1461,11 @@ This method is deprecated, see <a href="#//api/name/serverModel:joinedServerAsUs <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> @@ -1415,9 +1518,11 @@ This method is deprecated, see <a href="#//api/name/serverModel:joinedServerAsUs 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> @@ -1469,9 +1574,11 @@ mostly during initial connect).</p> <p>Called when a certificate is needed, but not persent, for a given operation.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> missingCertificateErrorForUser:(MKUser *)<em>user</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1518,9 +1625,11 @@ mostly during initial connect).</p> <p>Called when a permission error occurred for a given channel for a given user.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> permissionDenied:(MKPermission)<em>perm</em> forUser:(MKUser *)<em>user</em> inChannel:(MKChannel *)<em>channel</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1580,9 +1689,11 @@ the server detects that a client is using a too old version of the Mumble protoc to understand all error types.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> permissionDeniedForReason:(NSString *)<em>reason</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1629,9 +1740,11 @@ to understand all error types.</p> <p>Called whenever a text message is receieved.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> textMessageReceived:(MKTextMessage *)<em>msg</em> fromUser:(MKUser *)<em>user</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1683,9 +1796,11 @@ to understand all error types.</p> <p>Called when the user’s authenticated flag changes.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userAuthenticatedStateChanged:(MKUser *)<em>user</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1734,9 +1849,11 @@ 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> @@ -1794,9 +1911,11 @@ ban was initiated by the server.</p></dd> <p>Called when a user’s comment is changed.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userCommentChanged:(MKUser *)<em>user</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1843,9 +1962,11 @@ ban was initiated by the server.</p></dd> <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> @@ -1898,9 +2019,11 @@ the server.</p></dd> <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> @@ -1947,9 +2070,11 @@ the server.</p></dd> <p>Called when a new user joins the server.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userJoined:(MKUser *)<em>user</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -1996,9 +2121,11 @@ the server.</p></dd> <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> @@ -2056,9 +2183,11 @@ server initiated the kick.</p></dd> <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> @@ -2107,9 +2236,11 @@ This is also called when a user changes the channel he resides in (in which case user is equivalent to mover).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userMoved:(MKUser *)<em>user</em> toChannel:(MKChannel *)<em>chan</em> byUser:(MKUser *)<em>mover</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -2174,9 +2305,11 @@ This is also called when a user changes the channel he resides in (in which case user is equivalent to mover).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userMoved:(MKUser *)<em>user</em> toChannel:(MKChannel *)<em>chan</em> fromChannel:(MKChannel *)<em>prevChan</em> byUser:(MKUser *)<em>mover</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -2244,9 +2377,11 @@ performed by the server, mover is nil.</p></dd> <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> @@ -2293,9 +2428,11 @@ performed by the server, mover is nil.</p></dd> <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> @@ -2348,9 +2485,11 @@ the server.</p></dd> <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> @@ -2403,9 +2542,11 @@ May be nil if the server mute-deafened the user.</p></dd> <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> @@ -2452,9 +2593,11 @@ May be nil if the server mute-deafened the user.</p></dd> <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> @@ -2501,9 +2644,11 @@ May be nil if the server mute-deafened the user.</p></dd> <p>Called when a user removes his self-mute status.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userRemovedSelfMute:(MKUser *)<em>user</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -2550,9 +2695,11 @@ May be nil if the server mute-deafened the user.</p></dd> <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> @@ -2599,9 +2746,11 @@ May be nil if the server mute-deafened the user.</p></dd> <p>Called when a user is renamed.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userRenamed:(MKUser *)<em>user</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -2648,9 +2797,11 @@ May be nil if the server mute-deafened the user.</p></dd> <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> @@ -2697,9 +2848,11 @@ May be nil if the server mute-deafened the user.</p></dd> <p>Called when a user self-mutes himself.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userSelfMuted:(MKUser *)<em>user</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -2746,9 +2899,11 @@ May be nil if the server mute-deafened the user.</p></dd> <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> @@ -2795,9 +2950,11 @@ May be nil if the server mute-deafened the user.</p></dd> <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> @@ -2853,9 +3010,11 @@ the <a href="../Classes/MKServerModel.html">MKServerModel</a> that audio data fr server model is being played back.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userTalkStateChanged:(MKUser *)<em>user</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -2902,9 +3061,11 @@ server model is being played back.</p> <p>Called when a user’s texture is changed.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModel:(MKServerModel *)<em>model</em> userTextureChanged:(MKUser *)<em>user</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -2951,9 +3112,11 @@ server model is being played back.</p> <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> @@ -3006,9 +3169,11 @@ by the server.</p></dd> <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> @@ -3061,9 +3226,11 @@ server.</p></dd> <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> @@ -3116,9 +3283,11 @@ May be nil if the server removed the mute-deafen status.</p></dd> <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> @@ -3172,10 +3341,59 @@ unsupressed by the server.</p></dd> channel was full. (Note: A joinChannel: also counts as a move operation.)</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModelChannelFullError:(MKServerModel *)<em>model</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 error occurred.</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/serverModelChannelNameError:" title="serverModelChannelNameError:"></a> + <h3 class="subsubtitle method-title">serverModelChannelNameError:</h3> + + <div class="method-subsection brief-description"> + <p>Called when a channel create operation failed because the channel +name was invalid.</p> + </div> + + + + <div class="method-subsection method-declaration"><code>- (void)serverModelChannelNameError:(MKServerModel *)<em>model</em></code></div> + + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -3216,9 +3434,11 @@ channel was full. (Note: A joinChannel: also counts as a move operation.)</p> <p>Called when disconnected from the server (forcefully or not).</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModelDisconnected:(MKServerModel *)<em>model</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -3261,9 +3481,11 @@ channel was full. (Note: A joinChannel: also counts as a move operation.)</p> which was not allowed by the server.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModelInvalidChannelNameError:(MKServerModel *)<em>model</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -3305,9 +3527,11 @@ which was not allowed by the server.</p> <p>Called when an attempt to modify the SuperUser failed.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModelModifySuperUserError:(MKServerModel *)<em>model</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -3349,9 +3573,11 @@ which was not allowed by the server.</p> <p>Called when an action could not be performed on a temporary channel.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModelTemporaryChannelError:(MKServerModel *)<em>model</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -3393,9 +3619,11 @@ which was not allowed by the server.</p> <p>Called when the server received a text message that was too long.</p> </div> - + + <div class="method-subsection method-declaration"><code>- (void)serverModelTextMessageTooLongError:(MKServerModel *)<em>model</em></code></div> - + + <div class="method-subsection arguments-section parameters"> <h4 class="method-subtitle parameter-title">Parameters</h4> @@ -3440,9 +3668,9 @@ which was not allowed by the server.</p> <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-05-03)</span><br /> + <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-10-19)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 774)</a>.</span></p> + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 840)</a>.</span></p> </div> </div> @@ -3530,6 +3758,14 @@ which was not allowed by the server.</p> } window.onload = init; + + // If showing in Xcode, hide the TOC and Header + if (navigator.userAgent.match(/xcode/i)) { + document.getElementById("contents").className = "hideInXcode" + document.getElementById("tocContainer").className = "hideInXcode" + document.getElementById("top_header").className = "hideInXcode" + } + </script> </body> </html>
\ No newline at end of file diff --git a/css/styles.css b/css/styles.css index cd00d3a..bf946c0 100644 --- a/css/styles.css +++ b/css/styles.css @@ -28,12 +28,12 @@ li { margin-bottom: 10px; } -a { +a, a code { text-decoration: none; color: #36C; } -a:hover { +a:hover, a:hover code { text-decoration: underline; color: #36C; } @@ -47,6 +47,28 @@ h2 { padding-bottom: 2px; } +table { + margin-bottom: 4em; + border-collapse:collapse; + vertical-align: middle; +} + +td { + border: 1px solid #9BB3CD; + padding: .667em; + font-size: 100%; +} + +th { + border: 1px solid #9BB3CD; + padding: .3em .667em .3em .667em; + background: #93A5BB; + font-size: 103%; + font-weight: bold; + color: white; + text-align: left; +} + /* @group Common page elements */ #top_header { @@ -66,6 +88,7 @@ h2 { } #contents, #overview_contents { + -webkit-overflow-scrolling: touch; border-top: 1px solid #2B334F; position: absolute; top: 91px; @@ -386,6 +409,13 @@ li#jumpto_button select { height: 0.7em; } +.note { + border: 1px solid #5088C5; + background-color: white; + margin: 1.667em 0 1.75em 0; + padding: 0 .667em .083em .750em; +} + .warning { border: 1px solid #5088C5; background-color: #F0F3F7; @@ -423,12 +453,16 @@ li#jumpto_button select { } .section-specification table { + margin-bottom: 0em; border-top: 1px solid #d6e0e5; } .section-specification td { vertical-align: top; border-bottom: 1px solid #d6e0e5; + border-left-width: 0px; + border-right-width: 0px; + border-top-width: 0px; padding: .6em; } @@ -531,5 +565,20 @@ span.tooltip:hover span.tooltip { color: #666; } +#tocContainer.hideInXcode { + display: none; + border: 0px solid black; +} + +#top_header.hideInXcode { + display: none; +} + +#contents.hideInXcode { + border: 0px solid black; + top: 0px; + left: 0px; +} + /* @end */ diff --git a/hierarchy.html b/hierarchy.html index 921fa11..b9166fb 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -5,7 +5,7 @@ <title>MumbleKit Hierarchy</title> <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.5 (build 774)" /> + <meta name="generator" content="appledoc 2.1 (build 840)" /> </head> <body> <header id="top_header"> @@ -101,9 +101,9 @@ <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-05-03)</span><br /> + <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-10-19)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 774)</a>.</span></p> + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 840)</a>.</span></p> </div> @@ -5,7 +5,7 @@ <title>MumbleKit Reference</title> <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.5 (build 774)" /> + <meta name="generator" content="appledoc 2.1 (build 840)" /> </head> <body> <header id="top_header"> @@ -31,6 +31,8 @@ </div> <div id="container"> + + <div class="index-column"> @@ -89,9 +91,9 @@ <div id="footer"> <hr /> <div class="footer-copyright"> - <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-05-03)</span><br /> + <p><span class="copyright">© 2012 Mumble Developers. All rights reserved. (Last updated: 2012-10-19)</span><br /> - <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.0.5 (build 774)</a>.</span></p> + <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.1 (build 840)</a>.</span></p> </div> |