416 lines
18 KiB
HTML
416 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>AbstractCollection 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/AbstractCollection" class="dashAnchor"></a>
|
|
<a title="AbstractCollection Class Reference"></a>
|
|
<header>
|
|
<div class="content-wrapper">
|
|
<p><a href="../index.html">SwiftDDP Docs</a> (69% documented)</p>
|
|
</div>
|
|
</header>
|
|
<div class="content-wrapper">
|
|
<p id="breadcrumbs">
|
|
<a href="../index.html">SwiftDDP Reference</a>
|
|
<img id="carat" src="../img/carat.png" />
|
|
AbstractCollection 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/AbstractCollection.html">AbstractCollection</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/DDPClient.html">DDPClient</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/EJSON.html">EJSON</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/MeteorDocument.html">MeteorDocument</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes.html#/s:C8SwiftDDP11MeteorOAuth">MeteorOAuth</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/MeteorOAuthDialogViewController.html">MeteorOAuthDialogViewController</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/MeteorOAuthServices.html">MeteorOAuthServices</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-group-name">
|
|
<a href="../Global Variables.html">Global Variables</a>
|
|
<ul class="nav-group-tasks">
|
|
<li class="nav-group-task">
|
|
<a href="../Global Variables.html#/s:v8SwiftDDP18DDP_USER_DID_LOGINSS">DDP_USER_DID_LOGIN</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Global Variables.html#/s:v8SwiftDDP19DDP_USER_DID_LOGOUTSS">DDP_USER_DID_LOGOUT</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Global Variables.html#/s:v8SwiftDDP32METEOR_COLLECTION_SET_DID_CHANGESS">METEOR_COLLECTION_SET_DID_CHANGE</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="../Protocols.html">Protocols</a>
|
|
<ul class="nav-group-tasks">
|
|
<li class="nav-group-task">
|
|
<a href="../Protocols/MeteorCollectionType.html">MeteorCollectionType</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Protocols/SwiftDDPDelegate.html">SwiftDDPDelegate</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.html#/s:V8SwiftDDP10Completion">Completion</a>
|
|
</li>
|
|
<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>AbstractCollection</h1>
|
|
<p>Undocumented</p>
|
|
|
|
</section>
|
|
<section class="section task-group-section">
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vC8SwiftDDP18AbstractCollection4nameSS"></a>
|
|
<a name="//apple_ref/swift/Property/name" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vC8SwiftDDP18AbstractCollection4nameSS">name</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:vC8SwiftDDP18AbstractCollection6clientCCS_6Meteor6Client"></a>
|
|
<a name="//apple_ref/swift/Property/client" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vC8SwiftDDP18AbstractCollection6clientCCS_6Meteor6Client">client</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:FC8SwiftDDP18AbstractCollectioncFT4nameSS_S0_"></a>
|
|
<a name="//apple_ref/swift/Method/init(name:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP18AbstractCollectioncFT4nameSS_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>Undocumented</p>
|
|
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP18AbstractCollection16documentWasAddedFTSS2idSS6fieldsGSqCSo12NSDictionary__T_"></a>
|
|
<a name="//apple_ref/swift/Method/documentWasAdded(_:id:fields:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP18AbstractCollection16documentWasAddedFTSS2idSS6fieldsGSqCSo12NSDictionary__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>Invoked when a document has been sent from the server.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<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> <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:FC8SwiftDDP18AbstractCollection18documentWasChangedFTSS2idSS6fieldsGSqCSo12NSDictionary_7clearedGSqGSaSS___T_"></a>
|
|
<a name="//apple_ref/swift/Method/documentWasChanged(_:id:fields:cleared:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP18AbstractCollection18documentWasChangedFTSS2idSS6fieldsGSqCSo12NSDictionary_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>Invoked when a document has been changed on the server.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">documentWasChanged</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">String</span><span class="p">]?)</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>Optional array of strings (field names to delete)</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP18AbstractCollection18documentWasRemovedFTSS2idSS_T_"></a>
|
|
<a name="//apple_ref/swift/Method/documentWasRemoved(_:id:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP18AbstractCollection18documentWasRemovedFTSS2idSS_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>Invoked when a document has been removed on the server.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">documentWasRemoved</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="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>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section id="footer">
|
|
<p>© 2016 <a class="link" href="https://github.com/siegesmund/SwiftDDP" target="_blank" rel="external">Peter Siegesmund</a>. All rights reserved. (Last updated: 2016-04-12)</p>
|
|
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.6.0</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
|
</section>
|
|
</article>
|
|
</div>
|
|
</body>
|
|
</div>
|
|
</html>
|