dnrops
/
SwiftDDP
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
SwiftDDP/docs/Classes/MeteorCollection.html

306 lines
14 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<html lang="en">
<head>
<title>MeteorCollection Class Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset='utf-8'>
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Class/MeteorCollection" class="dashAnchor"></a>
<a title="MeteorCollection Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (61% documented)</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html"> Reference</a>
<img id="carat" src="../img/carat.png" />
MeteorCollection Class Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Classes/DDPClient.html">DDPClient</a>
</li>
<li class="nav-group-task">
<a href="../Classes/Meteor.html">Meteor</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MeteorCollection.html">MeteorCollection</a>
</li>
<li class="nav-group-task">
<a href="../Classes.html#/s:C8SwiftDDP14MeteorCoreData">MeteorCoreData</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MeteorCoreDataCollection.html">MeteorCoreDataCollection</a>
</li>
<li class="nav-group-task">
<a href="../Classes/MeteorCoreDataTableViewController.html">MeteorCoreDataTableViewController</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Enums.html">Enums</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/DDPMessageType.html">DDPMessageType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Extensions/DDPClient.html">DDPClient</a>
</li>
<li class="nav-group-task">
<a href="../Extensions/NSManagedObject.html">NSManagedObject</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Protocols/MeteorCoreDataCollectionDelegate.html">MeteorCoreDataCollectionDelegate</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/MeteorCoreDataStack.html">MeteorCoreDataStack</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Structs.html">Structs</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Structs/DDPError.html">DDPError</a>
</li>
<li class="nav-group-task">
<a href="../Structs/DDPEvents.html">DDPEvents</a>
</li>
<li class="nav-group-task">
<a href="../Structs/DDPMessage.html">DDPMessage</a>
</li>
<li class="nav-group-task">
<a href="../Structs/Result.html">Result</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>MeteorCollection</h1>
<div class="declaration">
<div class="Swift">
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">MeteorCollection</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">MeteorCollectionType</span></code></pre>
</div>
</div>
<p>MeteorCollection is a class created to provide a base class and api for integrating SwiftDDP with persistence stores. MeteorCollection
should generally be subclassed, with the methods documentWasAdded, documentWasChanged and documentWasRemoved facilitating communicating
with the datastore.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:FC8SwiftDDP16MeteorCollectioncFMS0_FT4nameSS_S0_"></a>
<a name="//apple_ref/swift/Method/init(name:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC8SwiftDDP16MeteorCollectioncFMS0_FT4nameSS_S0_">init(name:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Initializes a MeteorCollection 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="nf">init</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>name</em>
</code>
</td>
<td>
<div>
<p>The string name of the collection (must match the name of the collection on the server)</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC8SwiftDDP16MeteorCollection16documentWasAddedFS0_FTSS2idSS6fieldsGSqCSo12NSDictionary__T_"></a>
<a name="//apple_ref/swift/Method/documentWasAdded(_:id:fields:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC8SwiftDDP16MeteorCollection16documentWasAddedFS0_FTSS2idSS6fieldsGSqCSo12NSDictionary__T_">documentWasAdded(_:id:fields:)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Called when a document has been sent from the server. Always executes on the main queue</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">func</span> <span class="nf">documentWasAdded</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></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>
<li class="item">
<div>
<code>
<a name="/s:FC8SwiftDDP16MeteorCollection18documentWasChangedFS0_FTSS2idSS6fieldsGSqCSo12NSDictionary_7clearedGSqGSaSS___T_"></a>
<a name="//apple_ref/swift/Method/documentWasChanged(_:id:fields:cleared:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC8SwiftDDP16MeteorCollection18documentWasChangedFS0_FTSS2idSS6fieldsGSqCSo12NSDictionary_7clearedGSqGSaSS___T_">documentWasChanged(_:id:fields:cleared:)</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">class</span> <span class="kt">MeteorCollection</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">MeteorCollectionType</span></code></pre>
</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:FC8SwiftDDP16MeteorCollection18documentWasRemovedFS0_FTSS2idSS_T_"></a>
<a name="//apple_ref/swift/Method/documentWasRemoved(_:id:)" class="dashAnchor"></a>
<a class="token" href="#/s:FC8SwiftDDP16MeteorCollection18documentWasRemovedFS0_FTSS2idSS_T_">documentWasRemoved(_:id:)</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">class</span> <span class="kt">MeteorCollection</span><span class="p">:</span> <span class="kt">NSObject</span><span class="p">,</span> <span class="kt">MeteorCollectionType</span></code></pre>
</div>
</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-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>
</div>
</body>
</div>
</html>
Reference in New Issue View Git Blame Copy Permalink