updated docs

This commit is contained in:
Peter 2015-11-01 13:08:36 -05:00
parent c2be582123
commit ac8dbcc25e
46 changed files with 1056 additions and 560 deletions

View File

@ -12,7 +12,7 @@
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (25% documented)</p>
<p><a href="index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -134,9 +134,9 @@
<li class="item">
<div>
<code>
<a name="/s:C8SwiftDDP24MeteorCoreDataCollection"></a>
<a name="//apple_ref/swift/Class/MeteorCoreDataCollection" class="dashAnchor"></a>
<a class="token" href="#/s:C8SwiftDDP24MeteorCoreDataCollection">MeteorCoreDataCollection</a>
<a name="/s:C8SwiftDDP14MeteorCoreData"></a>
<a name="//apple_ref/swift/Class/MeteorCoreData" class="dashAnchor"></a>
<a class="token" href="#/s:C8SwiftDDP14MeteorCoreData">MeteorCoreData</a>
</code>
</div>
<div class="height-container">
@ -146,7 +146,6 @@
<div class="abstract">
<p>Undocumented</p>
<a href="Classes/MeteorCoreDataCollection.html" class="slightly-smaller">See more</a>
</div>
</section>
</div>
@ -177,6 +176,30 @@
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:C8SwiftDDP24MeteorCoreDataCollection"></a>
<a name="//apple_ref/swift/Class/MeteorCoreDataCollection" class="dashAnchor"></a>
<a class="token" href="#/s:C8SwiftDDP24MeteorCoreDataCollection">MeteorCoreDataCollection</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<a href="Classes/MeteorCoreDataCollection.html" class="slightly-smaller">See more</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
@ -221,33 +244,10 @@
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:C8SwiftDDP14MeteorCoreData"></a>
<a name="//apple_ref/swift/Class/MeteorCoreData" class="dashAnchor"></a>
<a class="token" href="#/s:C8SwiftDDP14MeteorCoreData">MeteorCoreData</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="DDPClient Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -1019,7 +1019,7 @@ in the subscription have been removed.</p>
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="Meteor Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -415,7 +415,7 @@ in the subscription has been sent by the server.</p>
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="Client Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../../index.html"> Docs</a> (25% documented)</p>
<p><a href="../../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -189,7 +189,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="MeteorCollection Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -246,7 +246,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="MeteorCoreDataCollection Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -436,7 +436,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="MeteorCoreDataTableViewController Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -170,7 +170,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -12,7 +12,7 @@
<a title="Enums Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (25% documented)</p>
<p><a href="index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -132,7 +132,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="DDPMessageType Enum Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -454,7 +454,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -12,7 +12,7 @@
<a title="Extensions Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (25% documented)</p>
<p><a href="index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -105,30 +105,6 @@
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)NSManagedObject"></a>
<a name="//apple_ref/swift/Extension/NSManagedObject" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)NSManagedObject">NSManagedObject</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<a href="Extensions/NSManagedObject.html" class="slightly-smaller">See more</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
@ -153,10 +129,34 @@
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)NSManagedObject"></a>
<a name="//apple_ref/swift/Extension/NSManagedObject" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)NSManagedObject">NSManagedObject</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<a href="Extensions/NSManagedObject.html" class="slightly-smaller">See more</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="DDPClient Extension Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -1292,7 +1292,7 @@ in the subscription has been sent by the server.</p>
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="NSManagedObject Extension Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -132,7 +132,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -12,7 +12,7 @@
<a title="Protocols Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (25% documented)</p>
<p><a href="index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -156,7 +156,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="MeteorCoreDataCollectionDelegate Protocol Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -151,7 +151,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="MeteorCoreDataStack Protocol Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -170,7 +170,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -12,7 +12,7 @@
<a title="Structs Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (25% documented)</p>
<p><a href="index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -120,10 +120,18 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Struct to encapsulate the result of a Meteor method call</p>
<a href="Structs/Result.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Result</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -172,10 +180,18 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>A struct encapsulating a DDP error message</p>
<a href="Structs/DDPError.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPError</span><span class="p">:</span> <span class="kt">ErrorType</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -196,10 +212,20 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>DDPEvents is a struct holder for callback closures that execute in response to
websocket and Meteor lifecyle events. New closures can be assigned to public
closures to modify the clients behavior in response to the trigger event.</p>
<a href="Structs/DDPEvents.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPEvents</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -208,7 +234,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="DDPError Struct Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -102,7 +102,13 @@
<section>
<section class="section">
<h1>DDPError</h1>
<p>Undocumented</p>
<div class="declaration">
<div class="Swift">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPError</span><span class="p">:</span> <span class="kt">ErrorType</span></code></pre>
</div>
</div>
<p>A struct encapsulating a DDP error message</p>
</section>
<section class="section task-group-section">
@ -121,9 +127,17 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The string error code</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">error</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="n">json</span><span class="p">?[</span><span class="s">"error"</span><span class="p">]</span> <span class="k">as?</span> <span class="kt">String</span> <span class="p">}</span> <span class="c1">// Error code</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -140,9 +154,17 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The detailed message given for an error returned from the server</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">reason</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="n">json</span><span class="p">?[</span><span class="s">"reason"</span><span class="p">]</span> <span class="k">as?</span> <span class="kt">String</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -159,9 +181,17 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The string providing error details</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">details</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="n">json</span><span class="p">?[</span><span class="s">"details"</span><span class="p">]</span> <span class="k">as?</span> <span class="kt">String</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -178,9 +208,17 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>If the original message parsed properly, it is included here</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">offendingMessage</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="n">json</span><span class="p">?[</span><span class="s">"offendingMessage"</span><span class="p">]</span> <span class="k">as?</span> <span class="kt">String</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -189,7 +227,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="DDPEvents Struct Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -102,50 +102,20 @@
<section>
<section class="section">
<h1>DDPEvents</h1>
<p>Undocumented</p>
<div class="declaration">
<div class="Swift">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPEvents</span></code></pre>
</div>
</div>
<p>DDPEvents is a struct holder for callback closures that execute in response to
websocket and Meteor lifecyle events. New closures can be assigned to public
closures to modify the clients behavior in response to the trigger event.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:vV8SwiftDDP9DDPEvents16onWebsocketCloseGSqFT4codeSi6reasonSS5cleanSb_T__"></a>
<a name="//apple_ref/swift/Property/onWebsocketClose" class="dashAnchor"></a>
<a class="token" href="#/s:vV8SwiftDDP9DDPEvents16onWebsocketCloseGSqFT4codeSi6reasonSS5cleanSb_T__">onWebsocketClose</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vV8SwiftDDP9DDPEvents16onWebsocketErrorFT5errorPSs9ErrorType__T_"></a>
<a name="//apple_ref/swift/Property/onWebsocketError" class="dashAnchor"></a>
<a class="token" href="#/s:vV8SwiftDDP9DDPEvents16onWebsocketErrorFT5errorPSs9ErrorType__T_">onWebsocketError</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
@ -159,9 +129,37 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>onConnected executes when the client makes a DDP connection</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">onConnected</span><span class="p">:</span> <span class="p">(</span><span class="nv">session</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">()</span> <span class="o">=</span> <span class="p">{</span><span class="n">session</span> <span class="k">in</span> <span class="n">log</span><span class="o">.</span><span class="nf">info</span><span class="p">(</span><span class="s">"connected with session: </span><span class="se">\(</span><span class="n">session</span><span class="se">)</span><span class="s">"</span><span class="p">)}</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>session</em>
</code>
</td>
<td>
<div>
<p>A string session id</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
@ -178,9 +176,17 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>onDisconnected executes when the client is disconnected</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">onDisconnected</span><span class="p">:</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="p">()</span> <span class="o">=</span> <span class="p">{</span><span class="n">log</span><span class="o">.</span><span class="nf">debug</span><span class="p">(</span><span class="s">"disconnected"</span><span class="p">)}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -197,9 +203,17 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>onFailed executes when an attempt to make a DDP connection fails</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">onFailed</span><span class="p">:</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="p">()</span> <span class="o">=</span> <span class="p">{</span><span class="n">log</span><span class="o">.</span><span class="nf">error</span><span class="p">(</span><span class="s">"failed"</span><span class="p">)}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -216,9 +230,63 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>onAdded executes when a document has been added to a local collection</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">onAdded</span><span class="p">:</span> <span class="p">((</span><span class="nv">collection</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">id</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">fields</span><span class="p">:</span><span class="kt">NSDictionary</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="p">())?</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>collection</em>
</code>
</td>
<td>
<div>
<p>the string name of the collection to which the document belongs</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>id</em>
</code>
</td>
<td>
<div>
<p>the string unique id that identifies the document on the server</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>fields</em>
</code>
</td>
<td>
<div>
<p>an optional NSDictionary with the documents properties</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
@ -235,9 +303,76 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>onChanged executes when the server sends an instruction to modify a local document</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">onChanged</span><span class="p">:</span> <span class="p">((</span><span class="nv">collection</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">id</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">fields</span><span class="p">:</span><span class="kt">NSDictionary</span><span class="p">?,</span> <span class="nv">cleared</span><span class="p">:</span><span class="kt">NSArray</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="p">())?</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>collection</em>
</code>
</td>
<td>
<div>
<p>the string name of the collection to which the document belongs</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>id</em>
</code>
</td>
<td>
<div>
<p>the string unique id that identifies the document on the server</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>fields</em>
</code>
</td>
<td>
<div>
<p>an optional NSDictionary with the documents properties</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>cleared</em>
</code>
</td>
<td>
<div>
<p>an optional array of string property names to delete</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
@ -254,9 +389,50 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>onRemoved executes when the server sends an instruction to remove a document from the local collection</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">onRemoved</span><span class="p">:</span> <span class="p">((</span><span class="nv">collection</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">id</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">())?</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>collection</em>
</code>
</td>
<td>
<div>
<p>the string name of the collection to which the document belongs</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>id</em>
</code>
</td>
<td>
<div>
<p>the string unique id that identifies the document on the server</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
@ -273,9 +449,38 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>onUpdated executes when the server sends a notification that all the consequences of a method call have
been communicated to the client</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">onUpdated</span><span class="p">:</span> <span class="p">((</span><span class="nv">methods</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="p">())?</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>methods</em>
</code>
</td>
<td>
<div>
<p>An array of method id strings</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
@ -292,9 +497,37 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>onError executes when the client receives a DDP error message</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">onError</span><span class="p">:</span> <span class="p">((</span><span class="nv">message</span><span class="p">:</span><span class="kt">DDPError</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">())?</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>message</em>
</code>
</td>
<td>
<div>
<p>A DDPError message describing the error</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
@ -303,7 +536,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="DDPMessage Struct Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -127,7 +127,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The message properties in an NSDictionary</p>
<p>The message&rsquo;s properties, stored as an NSDictionary</p>
</div>
<div class="declaration">
@ -154,14 +154,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Initialize a message struct, with a Json string</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">message</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span></code></pre>
</div>
</div>
@ -181,14 +181,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Initialize a message struct, with a dictionary of strings</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">message</span><span class="p">:[</span><span class="kt">String</span><span class="p">:</span><span class="kt">String</span><span class="p">])</span></code></pre>
</div>
</div>
@ -235,14 +235,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Returns the DDP message type, of type DDPMessageType enum</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">type</span><span class="p">:</span><span class="kt">DDPMessageType</span></code></pre>
</div>
</div>
@ -262,41 +262,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Returns a boolean value indicating if the message is an error message or not</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vV8SwiftDDP10DDPMessage4keysGSaSS_"></a>
<a name="//apple_ref/swift/Property/keys" class="dashAnchor"></a>
<a class="token" href="#/s:vV8SwiftDDP10DDPMessage4keysGSaSS_">keys</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isError</span><span class="p">:</span><span class="kt">Bool</span></code></pre>
</div>
</div>
@ -343,14 +316,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP message</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">message</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -370,14 +343,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP session string</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">session</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -397,14 +370,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP version string</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">version</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -424,14 +397,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP support string</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">support</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -451,14 +424,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP message id string</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">id</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -478,14 +451,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP name string</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -505,14 +478,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP param string</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">params</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -532,14 +505,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP error object</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">error</span><span class="p">:</span><span class="kt">DDPError</span><span class="p">?</span></code></pre>
</div>
</div>
@ -559,14 +532,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP collection name string</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">collection</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -586,14 +559,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP fields dictionary</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">fields</span><span class="p">:</span><span class="kt">NSDictionary</span><span class="p">?</span></code></pre>
</div>
</div>
@ -613,14 +586,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP cleared array. Contains an array of fields that should be removed</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">cleared</span><span class="p">:[</span><span class="kt">String</span><span class="p">]?</span></code></pre>
</div>
</div>
@ -640,14 +613,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional method name</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">method</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -667,14 +640,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional random seed JSON value (an arbitrary client-determined seed for pseudo-random generators)</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">randomSeed</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -694,14 +667,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional result object, containing the result of a method call</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">result</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">?</span></code></pre>
</div>
</div>
@ -721,14 +694,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional array of ids passed to &lsquo;method&rsquo;, all of whose writes have been reflected in data messages)</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">methods</span><span class="p">:[</span><span class="kt">String</span><span class="p">]?</span></code></pre>
</div>
</div>
@ -748,14 +721,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional array of id strings passed to &lsquo;sub&rsquo; which have sent their initial batch of data</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">subs</span><span class="p">:[</span><span class="kt">String</span><span class="p">]?</span></code></pre>
</div>
</div>
@ -775,14 +748,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional reason given for an error returned from the server</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">reason</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -802,14 +775,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional original error message</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">offendingMessage</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -821,7 +794,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="Result Struct Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -102,7 +102,13 @@
<section>
<section class="section">
<h1>Result</h1>
<p>Undocumented</p>
<div class="declaration">
<div class="Swift">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Result</span></code></pre>
</div>
</div>
<p>Struct to encapsulate the result of a Meteor method call</p>
</section>
<section class="section task-group-section">
@ -121,9 +127,17 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The result of the method call</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">result</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -140,9 +154,17 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>An error object describing the server-side error, or nil if the method completed successfully</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">error</span><span class="p">:</span><span class="kt">DDPError</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -151,7 +173,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -12,7 +12,7 @@
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (25% documented)</p>
<p><a href="index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -134,9 +134,9 @@
<li class="item">
<div>
<code>
<a name="/s:C8SwiftDDP24MeteorCoreDataCollection"></a>
<a name="//apple_ref/swift/Class/MeteorCoreDataCollection" class="dashAnchor"></a>
<a class="token" href="#/s:C8SwiftDDP24MeteorCoreDataCollection">MeteorCoreDataCollection</a>
<a name="/s:C8SwiftDDP14MeteorCoreData"></a>
<a name="//apple_ref/swift/Class/MeteorCoreData" class="dashAnchor"></a>
<a class="token" href="#/s:C8SwiftDDP14MeteorCoreData">MeteorCoreData</a>
</code>
</div>
<div class="height-container">
@ -146,7 +146,6 @@
<div class="abstract">
<p>Undocumented</p>
<a href="Classes/MeteorCoreDataCollection.html" class="slightly-smaller">See more</a>
</div>
</section>
</div>
@ -177,6 +176,30 @@
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:C8SwiftDDP24MeteorCoreDataCollection"></a>
<a name="//apple_ref/swift/Class/MeteorCoreDataCollection" class="dashAnchor"></a>
<a class="token" href="#/s:C8SwiftDDP24MeteorCoreDataCollection">MeteorCoreDataCollection</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<a href="Classes/MeteorCoreDataCollection.html" class="slightly-smaller">See more</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
@ -221,33 +244,10 @@
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:C8SwiftDDP14MeteorCoreData"></a>
<a name="//apple_ref/swift/Class/MeteorCoreData" class="dashAnchor"></a>
<a class="token" href="#/s:C8SwiftDDP14MeteorCoreData">MeteorCoreData</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="DDPClient Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -1019,7 +1019,7 @@ in the subscription have been removed.</p>
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="Meteor Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -415,7 +415,7 @@ in the subscription has been sent by the server.</p>
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="Client Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../../index.html"> Docs</a> (25% documented)</p>
<p><a href="../../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -189,7 +189,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="MeteorCollection Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -246,7 +246,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="MeteorCoreDataCollection Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -436,7 +436,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="MeteorCoreDataTableViewController Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -170,7 +170,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -12,7 +12,7 @@
<a title="Enums Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (25% documented)</p>
<p><a href="index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -132,7 +132,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="DDPMessageType Enum Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -454,7 +454,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -12,7 +12,7 @@
<a title="Extensions Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (25% documented)</p>
<p><a href="index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -105,30 +105,6 @@
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)NSManagedObject"></a>
<a name="//apple_ref/swift/Extension/NSManagedObject" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)NSManagedObject">NSManagedObject</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<a href="Extensions/NSManagedObject.html" class="slightly-smaller">See more</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
@ -153,10 +129,34 @@
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/c:objc(cs)NSManagedObject"></a>
<a name="//apple_ref/swift/Extension/NSManagedObject" class="dashAnchor"></a>
<a class="token" href="#/c:objc(cs)NSManagedObject">NSManagedObject</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<a href="Extensions/NSManagedObject.html" class="slightly-smaller">See more</a>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="DDPClient Extension Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -1292,7 +1292,7 @@ in the subscription has been sent by the server.</p>
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="NSManagedObject Extension Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -132,7 +132,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -12,7 +12,7 @@
<a title="Protocols Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (25% documented)</p>
<p><a href="index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -156,7 +156,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="MeteorCoreDataCollectionDelegate Protocol Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -151,7 +151,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="MeteorCoreDataStack Protocol Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -170,7 +170,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -12,7 +12,7 @@
<a title="Structs Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (25% documented)</p>
<p><a href="index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -120,10 +120,18 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Struct to encapsulate the result of a Meteor method call</p>
<a href="Structs/Result.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Result</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -172,10 +180,18 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>A struct encapsulating a DDP error message</p>
<a href="Structs/DDPError.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPError</span><span class="p">:</span> <span class="kt">ErrorType</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -196,10 +212,20 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>DDPEvents is a struct holder for callback closures that execute in response to
websocket and Meteor lifecyle events. New closures can be assigned to public
closures to modify the clients behavior in response to the trigger event.</p>
<a href="Structs/DDPEvents.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPEvents</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -208,7 +234,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="DDPError Struct Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -102,7 +102,13 @@
<section>
<section class="section">
<h1>DDPError</h1>
<p>Undocumented</p>
<div class="declaration">
<div class="Swift">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPError</span><span class="p">:</span> <span class="kt">ErrorType</span></code></pre>
</div>
</div>
<p>A struct encapsulating a DDP error message</p>
</section>
<section class="section task-group-section">
@ -121,9 +127,17 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The string error code</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">error</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="n">json</span><span class="p">?[</span><span class="s">"error"</span><span class="p">]</span> <span class="k">as?</span> <span class="kt">String</span> <span class="p">}</span> <span class="c1">// Error code</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -140,9 +154,17 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The detailed message given for an error returned from the server</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">reason</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="n">json</span><span class="p">?[</span><span class="s">"reason"</span><span class="p">]</span> <span class="k">as?</span> <span class="kt">String</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -159,9 +181,17 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The string providing error details</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">details</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="n">json</span><span class="p">?[</span><span class="s">"details"</span><span class="p">]</span> <span class="k">as?</span> <span class="kt">String</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -178,9 +208,17 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>If the original message parsed properly, it is included here</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">offendingMessage</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span> <span class="p">{</span> <span class="k">return</span> <span class="n">json</span><span class="p">?[</span><span class="s">"offendingMessage"</span><span class="p">]</span> <span class="k">as?</span> <span class="kt">String</span> <span class="p">}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -189,7 +227,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="DDPEvents Struct Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -102,50 +102,20 @@
<section>
<section class="section">
<h1>DDPEvents</h1>
<p>Undocumented</p>
<div class="declaration">
<div class="Swift">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPEvents</span></code></pre>
</div>
</div>
<p>DDPEvents is a struct holder for callback closures that execute in response to
websocket and Meteor lifecyle events. New closures can be assigned to public
closures to modify the clients behavior in response to the trigger event.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:vV8SwiftDDP9DDPEvents16onWebsocketCloseGSqFT4codeSi6reasonSS5cleanSb_T__"></a>
<a name="//apple_ref/swift/Property/onWebsocketClose" class="dashAnchor"></a>
<a class="token" href="#/s:vV8SwiftDDP9DDPEvents16onWebsocketCloseGSqFT4codeSi6reasonSS5cleanSb_T__">onWebsocketClose</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vV8SwiftDDP9DDPEvents16onWebsocketErrorFT5errorPSs9ErrorType__T_"></a>
<a name="//apple_ref/swift/Property/onWebsocketError" class="dashAnchor"></a>
<a class="token" href="#/s:vV8SwiftDDP9DDPEvents16onWebsocketErrorFT5errorPSs9ErrorType__T_">onWebsocketError</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
@ -159,9 +129,37 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>onConnected executes when the client makes a DDP connection</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">onConnected</span><span class="p">:</span> <span class="p">(</span><span class="nv">session</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">()</span> <span class="o">=</span> <span class="p">{</span><span class="n">session</span> <span class="k">in</span> <span class="n">log</span><span class="o">.</span><span class="nf">info</span><span class="p">(</span><span class="s">"connected with session: </span><span class="se">\(</span><span class="n">session</span><span class="se">)</span><span class="s">"</span><span class="p">)}</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>session</em>
</code>
</td>
<td>
<div>
<p>A string session id</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
@ -178,9 +176,17 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>onDisconnected executes when the client is disconnected</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">onDisconnected</span><span class="p">:</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="p">()</span> <span class="o">=</span> <span class="p">{</span><span class="n">log</span><span class="o">.</span><span class="nf">debug</span><span class="p">(</span><span class="s">"disconnected"</span><span class="p">)}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -197,9 +203,17 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>onFailed executes when an attempt to make a DDP connection fails</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">onFailed</span><span class="p">:</span> <span class="p">()</span> <span class="o">-&gt;</span> <span class="p">()</span> <span class="o">=</span> <span class="p">{</span><span class="n">log</span><span class="o">.</span><span class="nf">error</span><span class="p">(</span><span class="s">"failed"</span><span class="p">)}</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -216,9 +230,63 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>onAdded executes when a document has been added to a local collection</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">onAdded</span><span class="p">:</span> <span class="p">((</span><span class="nv">collection</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">id</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">fields</span><span class="p">:</span><span class="kt">NSDictionary</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="p">())?</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>collection</em>
</code>
</td>
<td>
<div>
<p>the string name of the collection to which the document belongs</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>id</em>
</code>
</td>
<td>
<div>
<p>the string unique id that identifies the document on the server</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>fields</em>
</code>
</td>
<td>
<div>
<p>an optional NSDictionary with the documents properties</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
@ -235,9 +303,76 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>onChanged executes when the server sends an instruction to modify a local document</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">onChanged</span><span class="p">:</span> <span class="p">((</span><span class="nv">collection</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">id</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">fields</span><span class="p">:</span><span class="kt">NSDictionary</span><span class="p">?,</span> <span class="nv">cleared</span><span class="p">:</span><span class="kt">NSArray</span><span class="p">?)</span> <span class="o">-&gt;</span> <span class="p">())?</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>collection</em>
</code>
</td>
<td>
<div>
<p>the string name of the collection to which the document belongs</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>id</em>
</code>
</td>
<td>
<div>
<p>the string unique id that identifies the document on the server</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>fields</em>
</code>
</td>
<td>
<div>
<p>an optional NSDictionary with the documents properties</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>cleared</em>
</code>
</td>
<td>
<div>
<p>an optional array of string property names to delete</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
@ -254,9 +389,50 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>onRemoved executes when the server sends an instruction to remove a document from the local collection</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">onRemoved</span><span class="p">:</span> <span class="p">((</span><span class="nv">collection</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">id</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">())?</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>collection</em>
</code>
</td>
<td>
<div>
<p>the string name of the collection to which the document belongs</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>id</em>
</code>
</td>
<td>
<div>
<p>the string unique id that identifies the document on the server</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
@ -273,9 +449,38 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>onUpdated executes when the server sends a notification that all the consequences of a method call have
been communicated to the client</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">onUpdated</span><span class="p">:</span> <span class="p">((</span><span class="nv">methods</span><span class="p">:</span> <span class="p">[</span><span class="kt">String</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="p">())?</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>methods</em>
</code>
</td>
<td>
<div>
<p>An array of method id strings</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
@ -292,9 +497,37 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>onError executes when the client receives a DDP error message</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">onError</span><span class="p">:</span> <span class="p">((</span><span class="nv">message</span><span class="p">:</span><span class="kt">DDPError</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="p">())?</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>message</em>
</code>
</td>
<td>
<div>
<p>A DDPError message describing the error</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
@ -303,7 +536,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="DDPMessage Struct Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -127,7 +127,7 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>The message properties in an NSDictionary</p>
<p>The message&rsquo;s properties, stored as an NSDictionary</p>
</div>
<div class="declaration">
@ -154,14 +154,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Initialize a message struct, with a Json string</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">message</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span></code></pre>
</div>
</div>
@ -181,14 +181,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Initialize a message struct, with a dictionary of strings</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">message</span><span class="p">:[</span><span class="kt">String</span><span class="p">:</span><span class="kt">String</span><span class="p">])</span></code></pre>
</div>
</div>
@ -235,14 +235,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Returns the DDP message type, of type DDPMessageType enum</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">type</span><span class="p">:</span><span class="kt">DDPMessageType</span></code></pre>
</div>
</div>
@ -262,41 +262,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>Returns a boolean value indicating if the message is an error message or not</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:vV8SwiftDDP10DDPMessage4keysGSaSS_"></a>
<a name="//apple_ref/swift/Property/keys" class="dashAnchor"></a>
<a class="token" href="#/s:vV8SwiftDDP10DDPMessage4keysGSaSS_">keys</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">isError</span><span class="p">:</span><span class="kt">Bool</span></code></pre>
</div>
</div>
@ -343,14 +316,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP message</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">message</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -370,14 +343,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP session string</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">session</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -397,14 +370,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP version string</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">version</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -424,14 +397,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP support string</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">support</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -451,14 +424,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP message id string</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">id</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -478,14 +451,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP name string</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -505,14 +478,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP param string</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">params</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -532,14 +505,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP error object</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">error</span><span class="p">:</span><span class="kt">DDPError</span><span class="p">?</span></code></pre>
</div>
</div>
@ -559,14 +532,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP collection name string</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">collection</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -586,14 +559,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP fields dictionary</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">fields</span><span class="p">:</span><span class="kt">NSDictionary</span><span class="p">?</span></code></pre>
</div>
</div>
@ -613,14 +586,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional DDP cleared array. Contains an array of fields that should be removed</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">cleared</span><span class="p">:[</span><span class="kt">String</span><span class="p">]?</span></code></pre>
</div>
</div>
@ -640,14 +613,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional method name</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">method</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -667,14 +640,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional random seed JSON value (an arbitrary client-determined seed for pseudo-random generators)</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">randomSeed</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -694,14 +667,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional result object, containing the result of a method call</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">result</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">?</span></code></pre>
</div>
</div>
@ -721,14 +694,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional array of ids passed to &lsquo;method&rsquo;, all of whose writes have been reflected in data messages)</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">methods</span><span class="p">:[</span><span class="kt">String</span><span class="p">]?</span></code></pre>
</div>
</div>
@ -748,14 +721,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional array of id strings passed to &lsquo;sub&rsquo; which have sent their initial batch of data</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">subs</span><span class="p">:[</span><span class="kt">String</span><span class="p">]?</span></code></pre>
</div>
</div>
@ -775,14 +748,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional reason given for an error returned from the server</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">reason</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -802,14 +775,14 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The optional original error message</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">DDPMessage</span></code></pre>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">offendingMessage</span><span class="p">:</span><span class="kt">String</span><span class="p">?</span></code></pre>
</div>
</div>
@ -821,7 +794,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -13,7 +13,7 @@
<a title="Result Struct Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (25% documented)</p>
<p><a href="../index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -102,7 +102,13 @@
<section>
<section class="section">
<h1>Result</h1>
<p>Undocumented</p>
<div class="declaration">
<div class="Swift">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">struct</span> <span class="kt">Result</span></code></pre>
</div>
</div>
<p>Struct to encapsulate the result of a Meteor method call</p>
</section>
<section class="section task-group-section">
@ -121,9 +127,17 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>The result of the method call</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">result</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -140,9 +154,17 @@
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>
<p>An error object describing the server-side error, or nil if the method completed successfully</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="Swift">
<p class="aside-title">Swift</p>
<pre class="highlight"><code><span class="kd">public</span> <span class="k">var</span> <span class="nv">error</span><span class="p">:</span><span class="kt">DDPError</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
@ -151,7 +173,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -12,7 +12,7 @@
<a title=" Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (25% documented)</p>
<p><a href="index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -125,7 +125,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -3,6 +3,12 @@ MeteorCoreDataTableViewController.swift
public func controller(controller: NSFetchedResultsController, didChangeObject anObject: AnyObject, atIndexPath indexPath: NSIndexPath?, forChangeType type: NSFetchedResultsChangeType, newIndexPath: NSIndexPath?)
public func controllerWillChangeContent(controller: NSFetchedResultsController)
public func controllerDidChangeContent(controller: NSFetchedResultsController)
MeteorCoreData.swift
public class MeteorCoreData
DDPClient.swift
public class DDPClient: NSObject
public var logLevel = XCGLogger.LogLevel.Debug
public class DDPClient : NSObject
MeteorCoreDataCollection.swift
public protocol MeteorCoreDataCollectionDelegate
func document(willBeCreatedWith fields:NSDictionary?, forObject object:NSManagedObject) -> NSManagedObject
@ -25,21 +31,6 @@ MeteorCoreDataCollection.swift
override public func documentWasAdded(collection:String, id:String, fields:NSDictionary?)
override public func documentWasChanged(collection:String, id:String, fields:NSDictionary?, cleared:[String]?)
override public func documentWasRemoved(collection:String, id:String)
CoreDataExtensions.swift
public var dictionary:NSDictionary
DDPClient.swift
public class DDPClient: NSObject
public var logLevel = XCGLogger.LogLevel.Debug
public class DDPClient : NSObject
MeteorCoreDataStack.swift
public protocol MeteorCoreDataStack
var mainContext: NSManagedObjectContext { get }
var backgroundContext: NSManagedObjectContext { get }
var managedObjectContext:NSManagedObjectContext { get }
DDPMethodResult.swift
public struct Result
public var result:AnyObject?
public var error:DDPError?
DDPMessage.swift
public enum DDPMessageType:String
case Connected = "connected"
@ -57,36 +48,13 @@ DDPMessage.swift
case Updated = "updated"
case Error = "error"
case Unhandled = "unhandled"
public init(message:String)
public init(message:[String:String])
public static func toString(json:AnyObject) -> String?
public var type:DDPMessageType
public var isError:Bool
public var keys:[String]
public func hasProperty(name:String) -> Bool
public var message:String?
public var session:String?
public var version:String?
public var support:String?
public var id:String?
public var name:String?
public var params:String?
public var error:DDPError?
public var collection:String?
public var fields:NSDictionary?
public var cleared:[String]?
public var method:String?
public var randomSeed:String?
public var result:AnyObject?
public var methods:[String]?
public var subs:[String]?
public var reason:String?
public var offendingMessage:String?
public struct DDPError
public var error:String? { return json?["error"] as? String } // Error code
public var reason:String? { return json?["reason"] as? String }
public var details:String? { return json?["details"] as? String }
public var offendingMessage:String? { return json?["offendingMessage"] as? String }
MeteorCoreDataStack.swift
public protocol MeteorCoreDataStack
var mainContext: NSManagedObjectContext { get }
var backgroundContext: NSManagedObjectContext { get }
var managedObjectContext:NSManagedObjectContext { get }
DDPExtensions.swift
public func signup(params:NSDictionary, callback:((result: AnyObject?, error: DDPError?) -> ())?)
public func signupWithEmail(email: String, password: String, callback: ((result:AnyObject?, error:DDPError?) -> ())?)
@ -109,17 +77,5 @@ Meteor.swift
public func documentWasAdded(collection:String, id:String, fields:NSDictionary?)
public func documentWasChanged(collection:String, id:String, fields:NSDictionary?, cleared:[String]?)
public func documentWasRemoved(collection:String, id:String)
MeteorCoreData.swift
public class MeteorCoreData
DDPEvents.swift
public struct DDPEvents
public var onWebsocketClose: ((code:Int, reason:String, clean:Bool) -> ())?
public var onWebsocketError: (error:ErrorType) -> () = {error in log.error("websocket error \(error)")}
public var onConnected: (session:String) -> () = {session in log.info("connected with session: \(session)")}
public var onDisconnected: () -> () = {log.debug("disconnected")}
public var onFailed: () -> () = {log.error("failed")}
public var onAdded: ((collection:String, id:String, fields:NSDictionary?) -> ())?
public var onChanged: ((collection:String, id:String, fields:NSDictionary?, cleared:NSArray?) -> ())?
public var onRemoved: ((collection:String, id:String) -> ())?
public var onUpdated: ((methods: [String]) -> ())?
public var onError: ((message:DDPError) -> ())?
CoreDataExtensions.swift
public var dictionary:NSDictionary

Binary file not shown.

View File

@ -12,7 +12,7 @@
<a title=" Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (25% documented)</p>
<p><a href="index.html"> Docs</a> (52% documented)</p>
</div>
</header>
<div class="content-wrapper">
@ -125,7 +125,7 @@
</section>
</section>
<section id="footer">
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-10-30)</p>
<p>&copy; 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>

View File

@ -3,6 +3,12 @@ MeteorCoreDataTableViewController.swift
public func controller(controller: NSFetchedResultsController, didChangeObject anObject: AnyObject, atIndexPath indexPath: NSIndexPath?, forChangeType type: NSFetchedResultsChangeType, newIndexPath: NSIndexPath?)
public func controllerWillChangeContent(controller: NSFetchedResultsController)
public func controllerDidChangeContent(controller: NSFetchedResultsController)
MeteorCoreData.swift
public class MeteorCoreData
DDPClient.swift
public class DDPClient: NSObject
public var logLevel = XCGLogger.LogLevel.Debug
public class DDPClient : NSObject
MeteorCoreDataCollection.swift
public protocol MeteorCoreDataCollectionDelegate
func document(willBeCreatedWith fields:NSDictionary?, forObject object:NSManagedObject) -> NSManagedObject
@ -25,21 +31,6 @@ MeteorCoreDataCollection.swift
override public func documentWasAdded(collection:String, id:String, fields:NSDictionary?)
override public func documentWasChanged(collection:String, id:String, fields:NSDictionary?, cleared:[String]?)
override public func documentWasRemoved(collection:String, id:String)
CoreDataExtensions.swift
public var dictionary:NSDictionary
DDPClient.swift
public class DDPClient: NSObject
public var logLevel = XCGLogger.LogLevel.Debug
public class DDPClient : NSObject
MeteorCoreDataStack.swift
public protocol MeteorCoreDataStack
var mainContext: NSManagedObjectContext { get }
var backgroundContext: NSManagedObjectContext { get }
var managedObjectContext:NSManagedObjectContext { get }
DDPMethodResult.swift
public struct Result
public var result:AnyObject?
public var error:DDPError?
DDPMessage.swift
public enum DDPMessageType:String
case Connected = "connected"
@ -57,36 +48,13 @@ DDPMessage.swift
case Updated = "updated"
case Error = "error"
case Unhandled = "unhandled"
public init(message:String)
public init(message:[String:String])
public static func toString(json:AnyObject) -> String?
public var type:DDPMessageType
public var isError:Bool
public var keys:[String]
public func hasProperty(name:String) -> Bool
public var message:String?
public var session:String?
public var version:String?
public var support:String?
public var id:String?
public var name:String?
public var params:String?
public var error:DDPError?
public var collection:String?
public var fields:NSDictionary?
public var cleared:[String]?
public var method:String?
public var randomSeed:String?
public var result:AnyObject?
public var methods:[String]?
public var subs:[String]?
public var reason:String?
public var offendingMessage:String?
public struct DDPError
public var error:String? { return json?["error"] as? String } // Error code
public var reason:String? { return json?["reason"] as? String }
public var details:String? { return json?["details"] as? String }
public var offendingMessage:String? { return json?["offendingMessage"] as? String }
MeteorCoreDataStack.swift
public protocol MeteorCoreDataStack
var mainContext: NSManagedObjectContext { get }
var backgroundContext: NSManagedObjectContext { get }
var managedObjectContext:NSManagedObjectContext { get }
DDPExtensions.swift
public func signup(params:NSDictionary, callback:((result: AnyObject?, error: DDPError?) -> ())?)
public func signupWithEmail(email: String, password: String, callback: ((result:AnyObject?, error:DDPError?) -> ())?)
@ -109,17 +77,5 @@ Meteor.swift
public func documentWasAdded(collection:String, id:String, fields:NSDictionary?)
public func documentWasChanged(collection:String, id:String, fields:NSDictionary?, cleared:[String]?)
public func documentWasRemoved(collection:String, id:String)
MeteorCoreData.swift
public class MeteorCoreData
DDPEvents.swift
public struct DDPEvents
public var onWebsocketClose: ((code:Int, reason:String, clean:Bool) -> ())?
public var onWebsocketError: (error:ErrorType) -> () = {error in log.error("websocket error \(error)")}
public var onConnected: (session:String) -> () = {session in log.info("connected with session: \(session)")}
public var onDisconnected: () -> () = {log.debug("disconnected")}
public var onFailed: () -> () = {log.error("failed")}
public var onAdded: ((collection:String, id:String, fields:NSDictionary?) -> ())?
public var onChanged: ((collection:String, id:String, fields:NSDictionary?, cleared:NSArray?) -> ())?
public var onRemoved: ((collection:String, id:String) -> ())?
public var onUpdated: ((methods: [String]) -> ())?
public var onError: ((message:DDPError) -> ())?
CoreDataExtensions.swift
public var dictionary:NSDictionary