1456 lines
72 KiB
HTML
1456 lines
72 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>DDPClient Extension 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/Extension/DDPClient" class="dashAnchor"></a>
|
|
<a title="DDPClient Extension Reference"></a>
|
|
<header>
|
|
<div class="content-wrapper">
|
|
<p><a href="../index.html"> Docs</a> (74% documented)</p>
|
|
</div>
|
|
</header>
|
|
<div class="content-wrapper">
|
|
<p id="breadcrumbs">
|
|
<a href="../index.html"> Reference</a>
|
|
<img id="carat" src="../img/carat.png" />
|
|
DDPClient Extension 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>
|
|
</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="../Extensions.html">Extensions</a>
|
|
<ul class="nav-group-tasks">
|
|
<li class="nav-group-task">
|
|
<a href="../Extensions/DDPClient.html">DDPClient</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>DDPClient</h1>
|
|
<div class="declaration">
|
|
<div class="Swift">
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">DDPClient</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
<section class="section task-group-section">
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient9subscribeFS0_FSSSS"></a>
|
|
<a name="//apple_ref/swift/Method/subscribe(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient9subscribeFS0_FSSSS">subscribe(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Sends a subscription request to 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">func</span> <span class="nf">subscribe</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="nf">sub</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="nv">params</span><span class="p">:</span><span class="kc">nil</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>name</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The name of the subscription</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient9subscribeFS0_FTSS6paramsGSaPSs9AnyObject___SS"></a>
|
|
<a name="//apple_ref/swift/Method/subscribe(_:params:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient9subscribeFS0_FTSS6paramsGSaPSs9AnyObject___SS">subscribe(_:params:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Sends a subscription request to 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">func</span> <span class="nf">subscribe</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">params</span><span class="p">:[</span><span class="kt">AnyObject</span><span class="p">])</span> <span class="o">-></span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="nf">sub</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="nv">params</span><span class="p">:</span><span class="n">params</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>name</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The name of the subscription</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>params</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>An object containing method arguments, if any</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient9subscribeFS0_FTSS6paramsGSqGSaPSs9AnyObject___8callbackGSqFT_T___SS"></a>
|
|
<a name="//apple_ref/swift/Method/subscribe(_:params:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient9subscribeFS0_FTSS6paramsGSqGSaPSs9AnyObject___8callbackGSqFT_T___SS">subscribe(_:params:callback:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Sends a subscription request to the server. If a callback is passed, the callback asynchronously
|
|
runs when the client receives a ‘ready’ message indicating that the initial subset of documents contained
|
|
in the subscription has been sent by 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">func</span> <span class="nf">subscribe</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">params</span><span class="p">:[</span><span class="kt">AnyObject</span><span class="p">]?,</span> <span class="nv">callback</span><span class="p">:</span> <span class="kt">DDPCallback</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="nf">sub</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="nv">params</span><span class="p">:</span><span class="n">params</span><span class="p">,</span> <span class="nv">callback</span><span class="p">:</span><span class="n">callback</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>name</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The name of the subscription</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>params</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>An object containing method arguments, if any</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>callback</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The closure to be executed when the server sends a ‘ready’ message</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient9subscribeFS0_FTSS8callbackGSqFT_T___SS"></a>
|
|
<a name="//apple_ref/swift/Method/subscribe(_:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient9subscribeFS0_FTSS8callbackGSqFT_T___SS">subscribe(_:callback:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Sends a subscription request to the server. If a callback is passed, the callback asynchronously
|
|
runs when the client receives a ‘ready’ message indicating that the initial subset of documents contained
|
|
in the subscription has been sent by 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">func</span> <span class="nf">subscribe</span><span class="p">(</span><span class="nv">name</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">callback</span><span class="p">:</span> <span class="kt">DDPCallback</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">String</span> <span class="p">{</span> <span class="k">return</span> <span class="nf">sub</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="nv">params</span><span class="p">:</span><span class="kc">nil</span><span class="p">,</span> <span class="nv">callback</span><span class="p">:</span><span class="n">callback</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>name</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The name of the subscription</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>callback</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The closure to be executed when the server sends a ‘ready’ message</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient6insertFS0_FTSS8documentCSo7NSArray8callbackGSqFT6resultGSqPSs9AnyObject__5errorGSqVS_8DDPError__T___SS"></a>
|
|
<a name="//apple_ref/swift/Method/insert(_:document:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient6insertFS0_FTSS8documentCSo7NSArray8callbackGSqFT6resultGSqPSs9AnyObject__5errorGSqVS_8DDPError__T___SS">insert(_:document:callback:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Asynchronously inserts a document into a collection on 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">func</span> <span class="nf">insert</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">document</span><span class="p">:</span> <span class="kt">NSArray</span><span class="p">,</span> <span class="nv">callback</span><span class="p">:</span> <span class="kt">DDPMethodCallback</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">String</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 name of the collection</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>document</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>An NSArray of documents to insert</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>callback</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A closure with result and error arguments describing the result of the operation</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient6insertFS0_FTSS8documentCSo7NSArray_SS"></a>
|
|
<a name="//apple_ref/swift/Method/insert(_:document:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient6insertFS0_FTSS8documentCSo7NSArray_SS">insert(_:document:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Asynchronously inserts a document into a collection on 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">func</span> <span class="nf">insert</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">document</span><span class="p">:</span> <span class="kt">NSArray</span><span class="p">)</span> <span class="o">-></span> <span class="kt">String</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 name of the collection</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>document</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>An NSArray of documents to insert</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient6insertFS0_FT4syncSS8documentCSo7NSArray_VS_6Result"></a>
|
|
<a name="//apple_ref/swift/Method/insert(sync:document:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient6insertFS0_FT4syncSS8documentCSo7NSArray_VS_6Result">insert(sync:document:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Synchronously inserts a document into a collection on the server. Cannot be used 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">insert</span><span class="p">(</span><span class="n">sync</span> <span class="nv">collection</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">document</span><span class="p">:</span> <span class="kt">NSArray</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Result</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 name of the collection</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>document</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>An NSArray of documents to insert</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient6updateFS0_FTSS8documentCSo7NSArray8callbackGSqFT6resultGSqPSs9AnyObject__5errorGSqVS_8DDPError__T___SS"></a>
|
|
<a name="//apple_ref/swift/Method/update(_:document:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient6updateFS0_FTSS8documentCSo7NSArray8callbackGSqFT6resultGSqPSs9AnyObject__5errorGSqVS_8DDPError__T___SS">update(_:document:callback:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Asynchronously updates a document into a collection on 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">func</span> <span class="nf">update</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">document</span><span class="p">:</span> <span class="kt">NSArray</span><span class="p">,</span> <span class="nv">callback</span><span class="p">:</span> <span class="kt">DDPMethodCallback</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">String</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 name of the collection</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>document</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>An NSArray of documents to update</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>callback</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A closure with result and error arguments describing the result of the operation</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient6updateFS0_FTSS8documentCSo7NSArray_SS"></a>
|
|
<a name="//apple_ref/swift/Method/update(_:document:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient6updateFS0_FTSS8documentCSo7NSArray_SS">update(_:document:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Asynchronously updates a document on 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">func</span> <span class="nf">update</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">document</span><span class="p">:</span> <span class="kt">NSArray</span><span class="p">)</span> <span class="o">-></span> <span class="kt">String</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 name of the collection</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>document</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>An NSArray of documents to update</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient6updateFS0_FT4syncSS8documentCSo7NSArray_VS_6Result"></a>
|
|
<a name="//apple_ref/swift/Method/update(sync:document:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient6updateFS0_FT4syncSS8documentCSo7NSArray_VS_6Result">update(sync:document:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Synchronously updates a document on the server. Cannot be used 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">update</span><span class="p">(</span><span class="n">sync</span> <span class="nv">collection</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">document</span><span class="p">:</span> <span class="kt">NSArray</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Result</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 name of the collection</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>document</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>An NSArray of documents to update</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient6removeFS0_FTSS8documentCSo7NSArray8callbackGSqFT6resultGSqPSs9AnyObject__5errorGSqVS_8DDPError__T___SS"></a>
|
|
<a name="//apple_ref/swift/Method/remove(_:document:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient6removeFS0_FTSS8documentCSo7NSArray8callbackGSqFT6resultGSqPSs9AnyObject__5errorGSqVS_8DDPError__T___SS">remove(_:document:callback:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Asynchronously removes a document on 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">func</span> <span class="nf">remove</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">document</span><span class="p">:</span> <span class="kt">NSArray</span><span class="p">,</span> <span class="nv">callback</span><span class="p">:</span> <span class="kt">DDPMethodCallback</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">String</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 name of the collection</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>document</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>An NSArray of documents to remove</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>callback</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A closure with result and error arguments describing the result of the operation</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient6removeFS0_FTSS8documentCSo7NSArray_SS"></a>
|
|
<a name="//apple_ref/swift/Method/remove(_:document:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient6removeFS0_FTSS8documentCSo7NSArray_SS">remove(_:document:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Asynchronously removes a document into a collection on 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">func</span> <span class="nf">remove</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">document</span><span class="p">:</span> <span class="kt">NSArray</span><span class="p">)</span> <span class="o">-></span> <span class="kt">String</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 name of the collection</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>document</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>An NSArray of documents to remove</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient6removeFS0_FT4syncSS8documentCSo7NSArray_VS_6Result"></a>
|
|
<a name="//apple_ref/swift/Method/remove(sync:document:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient6removeFS0_FT4syncSS8documentCSo7NSArray_VS_6Result">remove(sync:document:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Synchronously removes a document into a collection on the server. Cannot be used 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">remove</span><span class="p">(</span><span class="n">sync</span> <span class="nv">collection</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">document</span><span class="p">:</span> <span class="kt">NSArray</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Result</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 name of the collection</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>document</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>An NSArray of documents to remove</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient17loginWithPasswordFS0_FTSS8passwordSS8callbackGSqFT6resultGSqPSs9AnyObject__5errorGSqVS_8DDPError__T___T_"></a>
|
|
<a name="//apple_ref/swift/Method/loginWithPassword(_:password:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient17loginWithPasswordFS0_FTSS8passwordSS8callbackGSqFT6resultGSqPSs9AnyObject__5errorGSqVS_8DDPError__T___T_">loginWithPassword(_:password:callback:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Logs a user into the server using an email and password</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">loginWithPassword</span><span class="p">(</span><span class="nv">email</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">password</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">callback</span><span class="p">:</span> <span class="kt">DDPMethodCallback</span><span class="p">?)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>email</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>An email string</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>password</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A password string</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>callback</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A closure with result and error parameters describing the outcome of the operation</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient14loginWithTokenFS0_FGSqFT6resultGSqPSs9AnyObject__5errorGSqVS_8DDPError__T__Sb"></a>
|
|
<a name="//apple_ref/swift/Method/loginWithToken(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient14loginWithTokenFS0_FGSqFT6resultGSqPSs9AnyObject__5errorGSqVS_8DDPError__T__Sb">loginWithToken(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Attempts to login a user with a token, if one exists</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">loginWithToken</span><span class="p">(</span><span class="nv">callback</span><span class="p">:</span> <span class="kt">DDPMethodCallback</span><span class="p">?)</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>callback</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A closure with result and error parameters describing the outcome of the operation</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient6signupFS0_FTCSo12NSDictionary8callbackGSqFT6resultGSqPSs9AnyObject__5errorGSqVS_8DDPError__T___T_"></a>
|
|
<a name="//apple_ref/swift/Method/signup(_:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient6signupFS0_FTCSo12NSDictionary8callbackGSqFT6resultGSqPSs9AnyObject__5errorGSqVS_8DDPError__T___T_">signup(_:callback:)</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">DDPClient</span> <span class="p">:</span> <span class="kt">NSObject</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient15signupWithEmailFS0_FTSS8passwordSS8callbackGSqFT6resultGSqPSs9AnyObject__5errorGSqVS_8DDPError__T___T_"></a>
|
|
<a name="//apple_ref/swift/Method/signupWithEmail(_:password:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient15signupWithEmailFS0_FTSS8passwordSS8callbackGSqFT6resultGSqPSs9AnyObject__5errorGSqVS_8DDPError__T___T_">signupWithEmail(_:password:callback:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Invokes a Meteor method to create a user account with a given email and password on 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">func</span> <span class="nf">signupWithEmail</span><span class="p">(</span><span class="nv">email</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">password</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">callback</span><span class="p">:</span> <span class="p">((</span><span class="nv">result</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">?,</span> <span class="nv">error</span><span class="p">:</span><span class="kt">DDPError</span><span class="p">?)</span> <span class="o">-></span> <span class="p">())?)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient15signupWithEmailFS0_FTSS8passwordSS7profileCSo12NSDictionary8callbackGSqFT6resultGSqPSs9AnyObject__5errorGSqVS_8DDPError__T___T_"></a>
|
|
<a name="//apple_ref/swift/Method/signupWithEmail(_:password:profile:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient15signupWithEmailFS0_FTSS8passwordSS7profileCSo12NSDictionary8callbackGSqFT6resultGSqPSs9AnyObject__5errorGSqVS_8DDPError__T___T_">signupWithEmail(_:password:profile:callback:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Invokes a Meteor method to create a user account with a given email and password, and a NSDictionary containing a user profile</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">signupWithEmail</span><span class="p">(</span><span class="nv">email</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">password</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">profile</span><span class="p">:</span> <span class="kt">NSDictionary</span><span class="p">,</span> <span class="nv">callback</span><span class="p">:</span> <span class="p">((</span><span class="nv">result</span><span class="p">:</span><span class="kt">AnyObject</span><span class="p">?,</span> <span class="nv">error</span><span class="p">:</span><span class="kt">DDPError</span><span class="p">?)</span> <span class="o">-></span> <span class="p">())?)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient6userIdFS0_FT_GSqSS_"></a>
|
|
<a name="//apple_ref/swift/Method/userId()" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient6userIdFS0_FT_GSqSS_">userId()</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Returns the client userId, if it exists</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">userId</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span><span class="p">?</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient4userFS0_FT_GSqSS_"></a>
|
|
<a name="//apple_ref/swift/Method/user()" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient4userFS0_FT_GSqSS_">user()</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Returns the client’s username or email, if it exists</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">user</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span><span class="p">?</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient6logoutFS0_FT_T_"></a>
|
|
<a name="//apple_ref/swift/Method/logout()" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient6logoutFS0_FT_T_">logout()</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Logs a user out and removes their account data from NSUserDefaults</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">logout</span><span class="p">()</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient6logoutFS0_FGSqFT6resultGSqPSs9AnyObject__5errorGSqVS_8DDPError__T__T_"></a>
|
|
<a name="//apple_ref/swift/Method/logout(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient6logoutFS0_FGSqFT6resultGSqPSs9AnyObject__5errorGSqVS_8DDPError__T__T_">logout(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Logs a user out and removes their account data from NSUserDefaults.
|
|
When it completes, it posts a notification: DDP_USER_DID_LOGOUT 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">logout</span><span class="p">(</span><span class="nv">callback</span><span class="p">:</span><span class="kt">DDPMethodCallback</span><span class="p">?)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>callback</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A closure with result and error parameters describing the outcome of the operation</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient6resumeFS0_FTSS8callbackGSqFT_T___T_"></a>
|
|
<a name="//apple_ref/swift/Method/resume(_:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient6resumeFS0_FTSS8callbackGSqFT_T___T_">resume(_:callback:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Automatically attempts to resume a prior session, if one exists</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">resume</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">callback</span><span class="p">:</span><span class="kt">DDPCallback</span><span class="p">?)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>url</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The server url</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClientcFMS0_FT3urlSS5emailSS8passwordSS8callbackGSqFT6resultGSqPSs9AnyObject__5errorGSqVS_8DDPError__T___S0_"></a>
|
|
<a name="//apple_ref/swift/Method/init(url:email:password:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClientcFMS0_FT3urlSS5emailSS8passwordSS8callbackGSqFT6resultGSqPSs9AnyObject__5errorGSqVS_8DDPError__T___S0_">init(url:email:password:callback:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Connects and logs in with an email address and password in one action</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="n">convenience</span> <span class="nf">init</span><span class="p">(</span><span class="nv">url</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">email</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">password</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">callback</span><span class="p">:</span> <span class="kt">DDPMethodCallback</span><span class="p">?)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>url</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>String url, ex. wss://todos.meteor.com/websocket</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>email</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>String email address</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>password</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>String password</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>callback</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A closure with result and error parameters describing the outcome of the operation</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient8loggedInFS0_FT_Sb"></a>
|
|
<a name="//apple_ref/swift/Method/loggedIn()" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient8loggedInFS0_FT_Sb">loggedIn()</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Returns true if the user is logged in, and false otherwise</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">loggedIn</span><span class="p">()</span> <span class="o">-></span> <span class="kt">Bool</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
<section id="footer">
|
|
<p>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-12-18)</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>
|