<!DOCTYPE HTML> <html> <head> <meta http-equiv="Content-Type" content="html/html; charset=utf-8" /> <title>EMConnection Class Reference</title> <meta id="xcode-display" name="xcode-display" content="render"/> <meta name="viewport" content="width=550" /> <link rel="stylesheet" type="text/css" href="../css/styles.css" media="all" /> <link rel="stylesheet" type="text/css" media="print" href="../css/stylesPrint.css" /> <meta name="generator" content="appledoc 2.2 (build 961)" /> </head> <body> <div id="em-wrapper"> <style> #utility_bar { position: relative; height: 35px; /*background: #231f20 url(../images/bg_tagline.png) no-repeat right center;*/ background: #231f20 url(http://www.emmoco.com/images/bg_tagline.png) no-repeat right center; color: #efefef; overflow: hidden; padding-left: 10px; } #utility_bar p { margin-top: 9px; margin-bottom: 0; } #utility_bar a { color: #efefef; margin-right: 15px; padding: 2px; } #utility_bar a:hover { color: #fff; } #utility_bar a.selected { text-decoration: none; background-color: #555; } </style> <!-- begin utility bar --> <div id="utility_bar"> <!-- user info / logout link --> <p> <a href="http://em-hub.com/">Em-Hub</a> <a href="http://wiki.emmoco.com/">Wiki</a> <a href="http://android.emmoco.com/">Android Docs</a> <a class="selected" href="http://ios.emmoco.com/">iOS Docs</a> <a href="http://support.emmoco.com/">Support</a> </p> </div> <!-- end utility bar --> <header id="top_header"> <div id="library" class="hideInXcode"> <h1><a id="libraryTitle" href="../index.html">iOS Framework </a></h1> <a id="developerHome" href="../index.html">Emmoco, Inc.</a> </div> <div id="title" role="banner"> <h1 class="hideInXcode">EMConnection Class Reference</h1> </div> <ul id="headerButtons" role="toolbar"> <li id="toc_button"> <button aria-label="Show Table of Contents" role="checkbox" class="open" id="table_of_contents"><span class="disclosure"></span>Table of Contents</button> </li> <li id="jumpto_button" role="navigation"> <select id="jumpTo"> <option value="top">Jump To…</option> <option value="overview">Overview</option> <option value="tasks">Tasks</option> <option value="properties">Properties</option> <option value="//api/name/connectionAttemptTimeout"> connectionAttemptTimeout</option> <option value="//api/name/connectionClosedBlock"> connectionClosedBlock</option> <option value="//api/name/connectionDelegate"> connectionDelegate</option> <option value="//api/name/device"> device</option> <option value="//api/name/schema"> schema</option> <option value="instance_methods">Instance Methods</option> <option value="//api/name/cancelOpen"> - cancelOpen</option> <option value="//api/name/closeConnectionWithSuccess:onFail:"> - closeConnectionWithSuccess:onFail:</option> <option value="//api/name/initWithDevice:"> - initWithDevice:</option> <option value="//api/name/initWithDevice:schema:"> - initWithDevice:schema:</option> <option value="//api/name/isConnected"> - isConnected</option> <option value="//api/name/openConnectionWithSuccess:onFail:"> - openConnectionWithSuccess:onFail:</option> <option value="//api/name/readValueNamed:onSuccess:onFail:"> - readValueNamed:onSuccess:onFail:</option> <option value="//api/name/writeResource:onSuccess:onFail:"> - writeResource:onSuccess:onFail:</option> </select> </li> </ul> </header> <nav id="tocContainer" class="isShowingTOC"> <ul id="toc" role="tree"> <li role="treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#overview">Overview</a></span></li> <li role="treeitem" id="task_treeitem"><span class="nodisclosure"></span><span class="sectionName"><a href="#tasks">Tasks</a></span><ul> </ul></li> <li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#properties">Properties</a></span><ul> <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/connectionAttemptTimeout">connectionAttemptTimeout</a></span></li> <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/connectionClosedBlock">connectionClosedBlock</a></span></li> <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/connectionDelegate">connectionDelegate</a></span></li> <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/device">device</a></span></li> <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/schema">schema</a></span></li> </ul></li> <li role="treeitem" class="children"><span class="disclosure"></span><span class="sectionName"><a href="#instance_methods">Instance Methods</a></span><ul> <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/cancelOpen">cancelOpen</a></span></li> <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/closeConnectionWithSuccess:onFail:">closeConnectionWithSuccess:onFail:</a></span></li> <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithDevice:">initWithDevice:</a></span></li> <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/initWithDevice:schema:">initWithDevice:schema:</a></span></li> <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/isConnected">isConnected</a></span></li> <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/openConnectionWithSuccess:onFail:">openConnectionWithSuccess:onFail:</a></span></li> <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/readValueNamed:onSuccess:onFail:">readValueNamed:onSuccess:onFail:</a></span></li> <li><span class="nodisclosure"></span><span class="sectionName"><a href="#//api/name/writeResource:onSuccess:onFail:">writeResource:onSuccess:onFail:</a></span></li> </ul></li> </ul> </nav> <article> <div id="contents" class="isShowingTOC" role="main"> <a title="EMConnection Class Reference" name="top"></a> <div class="main-navigation navigation-top"> <ul> <li><a href="../index.html">Index</a></li> <li><a href="../hierarchy.html">Hierarchy</a></li> </ul> </div> <div id="header"> <div class="section-header"> <h1 class="title title-header">EMConnection Class Reference</h1> </div> </div> <div id="container"> <div class="section section-specification"><table cellspacing="0"><tbody> <tr> <td class="specification-title">Inherits from</td> <td class="specification-value">NSObject</td> </tr><tr> <td class="specification-title">Conforms to</td> <td class="specification-value"><a href="../Protocols/EMDeviceDelegate.html">EMDeviceDelegate</a></td> </tr><tr> <td class="specification-title">Declared in</td> <td class="specification-value">EMConnection.h<br />EMConnection.m</td> </tr> </tbody></table></div> <div class="section section-overview"> <a title="Overview" name="overview"></a> <h2 class="subtitle subtitle-overview">Overview</h2> <p>The state of the current connection. Use KVO to receive updates on this property and react to changes.</p> </div> <div class="section section-tasks"> <a title="Tasks" name="tasks"></a> <h2 class="subtitle subtitle-tasks">Tasks</h2> <ul class="task-list"> <li> <span class="tooltip"> <code><a href="#//api/name/connectionClosedBlock"> connectionClosedBlock</a></code> <span class="tooltip"><p>This block will be called when an open connection is closed for any reason</p></span> </span> <span class="task-item-suffix">property</span> </li><li> <span class="tooltip"> <code><a href="#//api/name/connectionAttemptTimeout"> connectionAttemptTimeout</a></code> <span class="tooltip"><p>The timeout interval for a pending connection</p></span> </span> <span class="task-item-suffix">property</span> </li><li> <span class="tooltip"> <code><a href="#//api/name/connectionDelegate"> connectionDelegate</a></code> <span class="tooltip"><p>The connection delegate. <a href="../Classes/EMConnectionManager.html">EMConnectionManager</a> will post connect and disconnect delegate messages to this object if it is set.</p></span> </span> <span class="task-item-suffix">property</span> </li><li> <span class="tooltip"> <code><a href="#//api/name/device"> device</a></code> <span class="tooltip"><p>The <a href="../Classes/EMDeviceBasicDescription.html">EMDeviceBasicDescription</a> used for conenction</p></span> </span> <span class="task-item-suffix">property</span> </li><li> <span class="tooltip"> <code><a href="#//api/name/schema"> schema</a></code> <span class="tooltip"><p>The schema for connection</p></span> </span> <span class="task-item-suffix">property</span> </li><li> <span class="tooltip"> <code><a href="#//api/name/initWithDevice:">– initWithDevice:</a></code> <span class="tooltip"><p>Creates a new EMConnection object. Actual connection and disconnection to the named target occurs through calls to open and close on this object.</p></span> </span> </li><li> <span class="tooltip"> <code><a href="#//api/name/initWithDevice:schema:">– initWithDevice:schema:</a></code> <span class="tooltip"><p>Creates a new EMTargetConnection object. Actual connection and disconnection to the named target occurs through calls to open and close on this object.</p></span> </span> </li><li> <span class="tooltip"> <code><a href="#//api/name/isConnected">– isConnected</a></code> <span class="tooltip"><p>Returns true if connected and false otherwise.</p></span> </span> </li><li> <span class="tooltip"> <code><a href="#//api/name/openConnectionWithSuccess:onFail:">– openConnectionWithSuccess:onFail:</a></code> <span class="tooltip"><p>Opens a connection to the @<a href="#//api/name/device">device</a> <a href="#//api/name/device">device</a> property</p></span> </span> </li><li> <span class="tooltip"> <code><a href="#//api/name/cancelOpen">– cancelOpen</a></code> <span class="tooltip"><p>Cancels the attempt to open this EMTargetConnection, posting the open block with a failed status.</p></span> </span> </li><li> <span class="tooltip"> <code><a href="#//api/name/closeConnectionWithSuccess:onFail:">– closeConnectionWithSuccess:onFail:</a></code> <span class="tooltip"><p>Closes the connection</p></span> </span> </li><li> <span class="tooltip"> <code><a href="#//api/name/readValueNamed:onSuccess:onFail:">– readValueNamed:onSuccess:onFail:</a></code> <span class="tooltip"><p>Reads a value</p></span> </span> </li><li> <span class="tooltip"> <code><a href="#//api/name/writeResource:onSuccess:onFail:">– writeResource:onSuccess:onFail:</a></code> <span class="tooltip"><p>Writes a resource to the <a href="#//api/name/device">device</a></p></span> </span> </li> </ul> </div> <div class="section section-methods"> <a title="Properties" name="properties"></a> <h2 class="subtitle subtitle-methods">Properties</h2> <div class="section-method"> <a name="//api/name/connectionAttemptTimeout" title="connectionAttemptTimeout"></a> <h3 class="subsubtitle method-title">connectionAttemptTimeout</h3> <div class="method-subsection brief-description"> <p>The timeout interval for a pending connection</p> </div> <div class="method-subsection method-declaration"><code>@property (atomic) NSTimeInterval connectionAttemptTimeout</code></div> <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> <p>The timeout interval for a pending connection</p> </div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <code class="declared-in-ref">EMConnection.h</code><br /> </div> </div> <div class="section-method"> <a name="//api/name/connectionClosedBlock" title="connectionClosedBlock"></a> <h3 class="subsubtitle method-title">connectionClosedBlock</h3> <div class="method-subsection brief-description"> <p>This block will be called when an open connection is closed for any reason</p> </div> <div class="method-subsection method-declaration"><code>@property (atomic, strong) EMResourceBlock connectionClosedBlock</code></div> <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> <p>This block will be called when an open connection is closed for any reason</p> </div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <code class="declared-in-ref">EMConnection.h</code><br /> </div> </div> <div class="section-method"> <a name="//api/name/connectionDelegate" title="connectionDelegate"></a> <h3 class="subsubtitle method-title">connectionDelegate</h3> <div class="method-subsection brief-description"> <p>The connection delegate. <a href="../Classes/EMConnectionManager.html">EMConnectionManager</a> will post connect and disconnect delegate messages to this object if it is set.</p> </div> <div class="method-subsection method-declaration"><code>@property (nonatomic, unsafe_unretained) id<EMConnectionDelegate> connectionDelegate</code></div> <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> <p>The connection delegate. <a href="../Classes/EMConnectionManager.html">EMConnectionManager</a> will post connect and disconnect delegate messages to this object if it is set.</p> </div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <code class="declared-in-ref">EMConnection.h</code><br /> </div> </div> <div class="section-method"> <a name="//api/name/device" title="device"></a> <h3 class="subsubtitle method-title">device</h3> <div class="method-subsection brief-description"> <p>The <a href="../Classes/EMDeviceBasicDescription.html">EMDeviceBasicDescription</a> used for conenction</p> </div> <div class="method-subsection method-declaration"><code>@property (nonatomic, strong) EMDeviceBasicDescription *device</code></div> <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> <p>The <a href="../Classes/EMDeviceBasicDescription.html">EMDeviceBasicDescription</a> used for conenction</p> </div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <code class="declared-in-ref">EMConnection.h</code><br /> </div> </div> <div class="section-method"> <a name="//api/name/schema" title="schema"></a> <h3 class="subsubtitle method-title">schema</h3> <div class="method-subsection brief-description"> <p>The schema for connection</p> </div> <div class="method-subsection method-declaration"><code>@property (nonatomic, strong) EMSchema *schema</code></div> <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> <p>The schema for connection</p> </div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <code class="declared-in-ref">EMConnection.h</code><br /> </div> </div> </div> <div class="section section-methods"> <a title="Instance Methods" name="instance_methods"></a> <h2 class="subtitle subtitle-methods">Instance Methods</h2> <div class="section-method"> <a name="//api/name/cancelOpen" title="cancelOpen"></a> <h3 class="subsubtitle method-title">cancelOpen</h3> <div class="method-subsection brief-description"> <p>Cancels the attempt to open this EMTargetConnection, posting the open block with a failed status.</p> </div> <div class="method-subsection method-declaration"><code>- (void)cancelOpen</code></div> <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> <p>Cancels the attempt to open this EMTargetConnection, posting the open block with a failed status.</p> </div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <code class="declared-in-ref">EMConnection.h</code><br /> </div> </div> <div class="section-method"> <a name="//api/name/closeConnectionWithSuccess:onFail:" title="closeConnectionWithSuccess:onFail:"></a> <h3 class="subsubtitle method-title">closeConnectionWithSuccess:onFail:</h3> <div class="method-subsection brief-description"> <p>Closes the connection</p> </div> <div class="method-subsection method-declaration"><code>- (void)closeConnectionWithSuccess:(EMResourceBlock)<em>successBlock</em> onFail:(EMFailBlock)<em>failBlock</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>successBlock</em></dt> <dd><p>A block to call on a successful disconnect</p></dd> </dl> <dl class="argument-def parameter-def"> <dt><em>failBlock</em></dt> <dd><p>A block to call on a failed disconnect</p></dd> </dl> </div> <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> <p>Closes the connection</p> </div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <code class="declared-in-ref">EMConnection.h</code><br /> </div> </div> <div class="section-method"> <a name="//api/name/initWithDevice:" title="initWithDevice:"></a> <h3 class="subsubtitle method-title">initWithDevice:</h3> <div class="method-subsection brief-description"> <p>Creates a new EMConnection object. Actual connection and disconnection to the named target occurs through calls to open and close on this object.</p> </div> <div class="method-subsection method-declaration"><code>- (id)initWithDevice:(EMDeviceBasicDescription *)<em>device</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>device</em></dt> <dd><p>The basic description of a <a href="#//api/name/device">device</a></p></dd> </dl> </div> <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> <p>Creates a new EMConnection object. Actual connection and disconnection to the named target occurs through calls to open and close on this object.</p> </div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <code class="declared-in-ref">EMConnection.h</code><br /> </div> </div> <div class="section-method"> <a name="//api/name/initWithDevice:schema:" title="initWithDevice:schema:"></a> <h3 class="subsubtitle method-title">initWithDevice:schema:</h3> <div class="method-subsection brief-description"> <p>Creates a new EMTargetConnection object. Actual connection and disconnection to the named target occurs through calls to open and close on this object.</p> </div> <div class="method-subsection method-declaration"><code>- (id)initWithDevice:(EMDeviceBasicDescription *)<em>device</em> schema:(EMSchema *)<em>resourceSchema</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>device</em></dt> <dd><p>the name of the target <a href="#//api/name/device">device</a>, including one of the pre-defined prefixes</p></dd> </dl> <dl class="argument-def parameter-def"> <dt><em>resourceSchema</em></dt> <dd><p>the <a href="#//api/name/schema">schema</a> describing the resources available in this connection</p></dd> </dl> </div> <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> <p>Creates a new EMTargetConnection object. Actual connection and disconnection to the named target occurs through calls to open and close on this object.</p> </div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <code class="declared-in-ref">EMConnection.h</code><br /> </div> </div> <div class="section-method"> <a name="//api/name/isConnected" title="isConnected"></a> <h3 class="subsubtitle method-title">isConnected</h3> <div class="method-subsection brief-description"> <p>Returns true if connected and false otherwise.</p> </div> <div class="method-subsection method-declaration"><code>- (BOOL)isConnected</code></div> <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> <p>Returns true if connected and false otherwise.</p> </div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <code class="declared-in-ref">EMConnection.h</code><br /> </div> </div> <div class="section-method"> <a name="//api/name/openConnectionWithSuccess:onFail:" title="openConnectionWithSuccess:onFail:"></a> <h3 class="subsubtitle method-title">openConnectionWithSuccess:onFail:</h3> <div class="method-subsection brief-description"> <p>Opens a connection to the @<a href="#//api/name/device">device</a> <a href="#//api/name/device">device</a> property</p> </div> <div class="method-subsection method-declaration"><code>- (void)openConnectionWithSuccess:(EMResourceBlock)<em>successBlock</em> onFail:(EMFailBlock)<em>failBlock</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>successBlock</em></dt> <dd><p>A block to call on a successful connect</p></dd> </dl> <dl class="argument-def parameter-def"> <dt><em>failBlock</em></dt> <dd><p>A block to call on a failed connect</p></dd> </dl> </div> <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> <p>Opens a connection to the @<a href="#//api/name/device">device</a> <a href="#//api/name/device">device</a> property</p> </div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <code class="declared-in-ref">EMConnection.h</code><br /> </div> </div> <div class="section-method"> <a name="//api/name/readValueNamed:onSuccess:onFail:" title="readValueNamed:onSuccess:onFail:"></a> <h3 class="subsubtitle method-title">readValueNamed:onSuccess:onFail:</h3> <div class="method-subsection brief-description"> <p>Reads a value</p> </div> <div class="method-subsection method-declaration"><code>- (void)readValueNamed:(NSString *)<em>resourceName</em> onSuccess:(EMResourceBlock)<em>successBlock</em> onFail:(EMFailBlock)<em>failBlock</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>resourceName</em></dt> <dd><p>The name of the resource to read</p></dd> </dl> <dl class="argument-def parameter-def"> <dt><em>successBlock</em></dt> <dd><p>A block to call on a successful read</p></dd> </dl> <dl class="argument-def parameter-def"> <dt><em>failBlock</em></dt> <dd><p>A block to call on a failed read</p></dd> </dl> </div> <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> <p>Reads a value</p> </div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <code class="declared-in-ref">EMConnection.h</code><br /> </div> </div> <div class="section-method"> <a name="//api/name/writeResource:onSuccess:onFail:" title="writeResource:onSuccess:onFail:"></a> <h3 class="subsubtitle method-title">writeResource:onSuccess:onFail:</h3> <div class="method-subsection brief-description"> <p>Writes a resource to the <a href="#//api/name/device">device</a></p> </div> <div class="method-subsection method-declaration"><code>- (void)writeResource:(EMResourceValue *)<em>resourceValue</em> onSuccess:(EMResourceBlock)<em>successBlock</em> onFail:(EMFailBlock)<em>failBlock</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>resourceValue</em></dt> <dd><p>The resource value</p></dd> </dl> <dl class="argument-def parameter-def"> <dt><em>successBlock</em></dt> <dd><p>A block to call on a successful write</p></dd> </dl> <dl class="argument-def parameter-def"> <dt><em>failBlock</em></dt> <dd><p>A block to call on a failed write</p></dd> </dl> </div> <div class="method-subsection discussion-section"> <h4 class="method-subtitle">Discussion</h4> <p>Writes a resource to the <a href="#//api/name/device">device</a></p> </div> <div class="method-subsection declared-in-section"> <h4 class="method-subtitle">Declared In</h4> <code class="declared-in-ref">EMConnection.h</code><br /> </div> </div> </div> </div> <div class="main-navigation navigation-bottom"> <ul> <li><a href="../index.html">Index</a></li> <li><a href="../hierarchy.html">Hierarchy</a></li> </ul> </div> <div id="footer"> <hr /> <style> #em-footer { background-color: #fff; height: 100px; font-size: 90%; overflow: hidden; } #em-footer_logo_container { position: relative; background-color: #d2d2d2; height: 70px; margin-bottom: 3px; } #em-footer_logo_container a { position: absolute; right: 7px; top: 7px; } </style> <!-- begin em-footer --> <div id="em-footer"> <div id="em-footer_logo_container"><a href="http://www.emmoco.com/"><img src="http://www.emmoco.com/images/logo_emhub_footer.png" alt="" width="85" height="57" alt="EMMOCO LOGO" /></a></div> </div> <div class="footer-copyright"> <p><span class="copyright">© 2014 Emmoco, Inc.. All rights reserved. (Last updated: 2014-02-21)</span><br /> <span class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2 (build 961)</a>.</span></p> </div> </div> </div> </article> <script type="text/javascript"> function jumpToChange() { window.location.hash = this.options[this.selectedIndex].value; } function toggleTOC() { var contents = document.getElementById('contents'); var tocContainer = document.getElementById('tocContainer'); if (this.getAttribute('class') == 'open') { this.setAttribute('class', ''); contents.setAttribute('class', ''); tocContainer.setAttribute('class', ''); window.name = "hideTOC"; } else { this.setAttribute('class', 'open'); contents.setAttribute('class', 'isShowingTOC'); tocContainer.setAttribute('class', 'isShowingTOC'); window.name = ""; } return false; } function toggleTOCEntryChildren(e) { e.stopPropagation(); var currentClass = this.getAttribute('class'); if (currentClass == 'children') { this.setAttribute('class', 'children open'); } else if (currentClass == 'children open') { this.setAttribute('class', 'children'); } return false; } function tocEntryClick(e) { e.stopPropagation(); return true; } function init() { var selectElement = document.getElementById('jumpTo'); selectElement.addEventListener('change', jumpToChange, false); var tocButton = document.getElementById('table_of_contents'); tocButton.addEventListener('click', toggleTOC, false); var taskTreeItem = document.getElementById('task_treeitem'); if (taskTreeItem.getElementsByTagName('li').length > 0) { taskTreeItem.setAttribute('class', 'children'); taskTreeItem.firstChild.setAttribute('class', 'disclosure'); } var tocList = document.getElementById('toc'); var tocEntries = tocList.getElementsByTagName('li'); for (var i = 0; i < tocEntries.length; i++) { tocEntries[i].addEventListener('click', toggleTOCEntryChildren, false); } var tocLinks = tocList.getElementsByTagName('a'); for (var i = 0; i < tocLinks.length; i++) { tocLinks[i].addEventListener('click', tocEntryClick, false); } if (window.name == "hideTOC") { toggleTOC.call(tocButton); } } window.onload = init; </script> </body> </html>