1652 lines
83 KiB
HTML
1652 lines
83 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>Meteor 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/Meteor" class="dashAnchor"></a>
|
|
<a title="Meteor 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" />
|
|
Meteor 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>Meteor</h1>
|
|
<div class="declaration">
|
|
<div class="language">
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">Meteor</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<p>Meteor is a class to simplify communicating with and consuming MeteorJS server services</p>
|
|
|
|
</section>
|
|
<section class="section task-group-section">
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:ZvC8SwiftDDP6Meteor6clientCS0_6Client"></a>
|
|
<a name="//apple_ref/swift/Variable/client" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZvC8SwiftDDP6Meteor6clientCS0_6Client">client</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>client is a singleton instance of DDPClient</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">static</span> <span class="k">let</span> <span class="nv">client</span> <span class="o">=</span> <span class="kt">Meteor</span><span class="o">.</span><span class="kt">Client</span><span class="p">()</span> <span class="c1">// Client is a singleton object</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:ZFC8SwiftDDP6Meteor10collectionFSSGSqPS_20MeteorCollectionType__"></a>
|
|
<a name="//apple_ref/swift/Method/collection(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor10collectionFSSGSqPS_20MeteorCollectionType__">collection(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>returns a Meteor collection, if it exists</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">static</span> <span class="kd">func</span> <span class="nf">collection</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">MeteorCollectionType</span><span class="p">?</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:ZFC8SwiftDDP6Meteor9subscribeFSSSS"></a>
|
|
<a name="//apple_ref/swift/Method/subscribe(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor9subscribeFSSSS">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="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</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="n">client</span><span class="o">.</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:ZFC8SwiftDDP6Meteor9subscribeFTSS6paramsGSaPs9AnyObject___SS"></a>
|
|
<a name="//apple_ref/swift/Method/subscribe(_:params:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor9subscribeFTSS6paramsGSaPs9AnyObject___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="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</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="n">client</span><span class="o">.</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:ZFC8SwiftDDP6Meteor9subscribeFTSS6paramsGSqGSaPs9AnyObject___8callbackGSqFT_T___SS"></a>
|
|
<a name="//apple_ref/swift/Method/subscribe(_:params:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor9subscribeFTSS6paramsGSqGSaPs9AnyObject___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="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</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="n">client</span><span class="o">.</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:ZFC8SwiftDDP6Meteor9subscribeFTSS8callbackGSqFT_T___SS"></a>
|
|
<a name="//apple_ref/swift/Method/subscribe(_:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor9subscribeFTSS8callbackGSqFT_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="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</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="n">client</span><span class="o">.</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:ZFC8SwiftDDP6Meteor11unsubscribeFSSGSaSS_"></a>
|
|
<a name="//apple_ref/swift/Method/unsubscribe(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor11unsubscribeFSSGSaSS_">unsubscribe(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Sends an unsubscribe request to the server. Unsubscibes to all subscriptions with the provided name.
|
|
- parameter name: The name of the subscription.</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">static</span> <span class="kd">func</span> <span class="nf">unsubscribe</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="p">[</span><span class="kt">String</span><span class="p">]</span> <span class="p">{</span> <span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="nf">unsub</span><span class="p">(</span><span class="nv">withName</span><span class="p">:</span> <span class="n">name</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:ZFC8SwiftDDP6Meteor11unsubscribeFT6withIdSS_T_"></a>
|
|
<a name="//apple_ref/swift/Method/unsubscribe(withId:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor11unsubscribeFT6withIdSS_T_">unsubscribe(withId:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Sends an unsubscribe request to the server using a subscription id. This allows fine-grained control of subscriptions. For example, you can unsubscribe to specific combinations of subscriptions and subscription parameters.
|
|
- parameter id: An id string returned from a subscription request</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">static</span> <span class="kd">func</span> <span class="nf">unsubscribe</span><span class="p">(</span><span class="n">withId</span> <span class="nv">id</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">client</span><span class="o">.</span><span class="nf">unsub</span><span class="p">(</span><span class="nv">withId</span><span class="p">:</span> <span class="n">id</span><span class="p">,</span> <span class="nv">callback</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>id</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>An id string returned from a subscription request</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:ZFC8SwiftDDP6Meteor11unsubscribeFT6withIdSS8callbackGSqFT_T___T_"></a>
|
|
<a name="//apple_ref/swift/Method/unsubscribe(withId:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor11unsubscribeFT6withIdSS8callbackGSqFT_T___T_">unsubscribe(withId: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 an unsubscribe request to the server using a subscription id. This allows fine-grained control of subscriptions. For example, you can unsubscribe to specific combinations of subscriptions and subscription parameters. If a callback is passed, the callback asynchronously
|
|
runs when the unsubscribe transaction is complete.
|
|
- parameter id: An id string returned from a subscription request
|
|
- parameter callback: The closure to be executed when the method has been executed</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">static</span> <span class="kd">func</span> <span class="nf">unsubscribe</span><span class="p">(</span><span class="n">withId</span> <span class="nv">id</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="p">{</span> <span class="k">return</span> <span class="n">client</span><span class="o">.</span><span class="nf">unsub</span><span class="p">(</span><span class="nv">withId</span><span class="p">:</span> <span class="n">id</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>id</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>An id string returned from a subscription request</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>callback</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The closure to be executed when the method has been executed</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:ZFC8SwiftDDP6Meteor4callFTSS6paramsGSqGSaPs9AnyObject___8callbackGSqFT6resultGSqPS1___5errorGSqVS_8DDPError__T___GSqSS_"></a>
|
|
<a name="//apple_ref/swift/Method/call(_:params:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor4callFTSS6paramsGSqGSaPs9AnyObject___8callbackGSqFT6resultGSqPS1___5errorGSqVS_8DDPError__T___GSqSS_">call(_: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>Calls a method on the server. If a callback is passed, the callback is asynchronously
|
|
executed when the method has completed. The callback takes two arguments: result and error. It
|
|
the method call is successful, result contains the return value of the method, if any. If the method fails,
|
|
error contains information about the error.</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">static</span> <span class="kd">func</span> <span class="nf">call</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">DDPMethodCallback</span><span class="p">?)</span> <span class="o">-></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 name of the method</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>params</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>An array 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 method has been executed</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:ZFC8SwiftDDP6Meteor7connectFTSS5emailSS8passwordSS_T_"></a>
|
|
<a name="//apple_ref/swift/Method/connect(_:email:password:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor7connectFTSS5emailSS8passwordSS_T_">connect(_:email:password:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Call a single function to establish a DDP connection, and login with email and password</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">static</span> <span class="kd">func</span> <span class="nf">connect</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></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>url</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The url of a Meteor server</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>email</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A string email address associated with a Meteor account</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>password</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A string password</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:ZFC8SwiftDDP6Meteor7connectFSST_"></a>
|
|
<a name="//apple_ref/swift/Method/connect(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor7connectFSST_">connect(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Connect to a Meteor server and resume a prior session, if the user was logged in</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">static</span> <span class="kd">func</span> <span class="nf">connect</span><span class="p">(</span><span class="nv">url</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>url</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The url of a Meteor server</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:ZFC8SwiftDDP6Meteor7connectFTSS8callbackGSqFT_T___T_"></a>
|
|
<a name="//apple_ref/swift/Method/connect(_:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor7connectFTSS8callbackGSqFT_T___T_">connect(_:callback:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Connect to a Meteor server and resume a prior session, if the user was logged in</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">static</span> <span class="kd">func</span> <span class="nf">connect</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 url of a Meteor server</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>callback</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>An optional closure to be executed after the connection is established</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:ZFC8SwiftDDP6Meteor15signupWithEmailFTSS8passwordSS8callbackGSqFT6resultGSqPs9AnyObject__5errorGSqVS_8DDPError__T___T_"></a>
|
|
<a name="//apple_ref/swift/Method/signupWithEmail(_:password:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor15signupWithEmailFTSS8passwordSS8callbackGSqFT6resultGSqPs9AnyObject__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>Creates a user account on the server with an email and password</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">static</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="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:ZFC8SwiftDDP6Meteor15signupWithEmailFTSS8passwordSS7profileCSo12NSDictionary8callbackGSqFT6resultGSqPs9AnyObject__5errorGSqVS_8DDPError__T___T_"></a>
|
|
<a name="//apple_ref/swift/Method/signupWithEmail(_:password:profile:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor15signupWithEmailFTSS8passwordSS7profileCSo12NSDictionary8callbackGSqFT6resultGSqPs9AnyObject__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>Creates a user account on the server with an email and password</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">static</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="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>profile</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A dictionary containing the user profile</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:ZFC8SwiftDDP6Meteor18signupWithUsernameFTSS8passwordSS5emailGSqSS_7profileGSqCSo12NSDictionary_8callbackGSqFT6resultGSqPs9AnyObject__5errorGSqVS_8DDPError__T___T_"></a>
|
|
<a name="//apple_ref/swift/Method/signupWithUsername(_:password:email:profile:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor18signupWithUsernameFTSS8passwordSS5emailGSqSS_7profileGSqCSo12NSDictionary_8callbackGSqFT6resultGSqPs9AnyObject__5errorGSqVS_8DDPError__T___T_">signupWithUsername(_:password:email: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>Creates a user account on the server with a username and password</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">static</span> <span class="kd">func</span> <span class="nf">signupWithUsername</span><span class="p">(</span><span class="nv">username</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">email</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</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="o">=</span> <span class="kc">nil</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="kc">nil</span><span class="p">)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>username</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A username 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>email</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>An email to be associated with the account</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>profile</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A dictionary containing the user profile</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:ZFC8SwiftDDP6Meteor17loginWithPasswordFTSS8passwordSS8callbackGSqFT6resultGSqPs9AnyObject__5errorGSqVS_8DDPError__T___T_"></a>
|
|
<a name="//apple_ref/swift/Method/loginWithPassword(_:password:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor17loginWithPasswordFTSS8passwordSS8callbackGSqFT6resultGSqPs9AnyObject__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="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</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:ZFC8SwiftDDP6Meteor17loginWithPasswordFTSS8passwordSS_T_"></a>
|
|
<a name="//apple_ref/swift/Method/loginWithPassword(_:password:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor17loginWithPasswordFTSS8passwordSS_T_">loginWithPassword(_:password:)</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="language">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">static</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></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>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:ZFC8SwiftDDP6Meteor17loginWithUsernameFTSS8passwordSS8callbackGSqFT6resultGSqPs9AnyObject__5errorGSqVS_8DDPError__T___T_"></a>
|
|
<a name="//apple_ref/swift/Method/loginWithUsername(_:password:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor17loginWithUsernameFTSS8passwordSS8callbackGSqFT6resultGSqPs9AnyObject__5errorGSqVS_8DDPError__T___T_">loginWithUsername(_: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 a username and password</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">static</span> <span class="kd">func</span> <span class="nf">loginWithUsername</span><span class="p">(</span><span class="nv">username</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> <span class="o">=</span> <span class="kc">nil</span><span class="p">)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>username</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A username 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:ZFC8SwiftDDP6Meteor16loginWithTwitteruRxCSo16UIViewControllerrFxT_"></a>
|
|
<a name="//apple_ref/swift/Method/loginWithTwitter(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor16loginWithTwitteruRxCSo16UIViewControllerrFxT_">loginWithTwitter(_:)</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 Twitter</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">static</span> <span class="kd">func</span> <span class="n">loginWithTwitter</span><span class="o"><</span><span class="kt">T</span><span class="p">:</span> <span class="kt">UIViewController</span><span class="o">></span><span class="p">(</span><span class="nv">viewController</span><span class="p">:</span> <span class="kt">T</span><span class="p">)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>viewController</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A view controller from which to launch the OAuth modal dialog</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:ZFC8SwiftDDP6Meteor17loginWithFacebookuRxCSo16UIViewControllerrFTSS14viewControllerx_T_"></a>
|
|
<a name="//apple_ref/swift/Method/loginWithFacebook(_:viewController:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor17loginWithFacebookuRxCSo16UIViewControllerrFTSS14viewControllerx_T_">loginWithFacebook(_:viewController:)</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 Facebook</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">static</span> <span class="kd">func</span> <span class="n">loginWithFacebook</span><span class="o"><</span><span class="kt">T</span><span class="p">:</span> <span class="kt">UIViewController</span><span class="o">></span><span class="p">(</span><span class="nv">clientId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">viewController</span><span class="p">:</span> <span class="kt">T</span><span class="p">)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>viewController</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A view controller from which to launch the OAuth modal dialog</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>clientId</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The apps client id, provided by the service (Facebook, Google, etc.)</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:ZFC8SwiftDDP6Meteor15loginWithGithubuRxCSo16UIViewControllerrFTSS14viewControllerx_T_"></a>
|
|
<a name="//apple_ref/swift/Method/loginWithGithub(_:viewController:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor15loginWithGithubuRxCSo16UIViewControllerrFTSS14viewControllerx_T_">loginWithGithub(_:viewController:)</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 Github</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">static</span> <span class="kd">func</span> <span class="n">loginWithGithub</span><span class="o"><</span><span class="kt">T</span><span class="p">:</span> <span class="kt">UIViewController</span><span class="o">></span><span class="p">(</span><span class="nv">clientId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">viewController</span><span class="p">:</span> <span class="kt">T</span><span class="p">)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>viewController</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A view controller from which to launch the OAuth modal dialog</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>clientId</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The apps client id, provided by the service (Facebook, Google, etc.)</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:ZFC8SwiftDDP6Meteor15loginWithGoogleuRxCSo16UIViewControllerrFTSS14viewControllerx_T_"></a>
|
|
<a name="//apple_ref/swift/Method/loginWithGoogle(_:viewController:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor15loginWithGoogleuRxCSo16UIViewControllerrFTSS14viewControllerx_T_">loginWithGoogle(_:viewController:)</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 Google</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">static</span> <span class="kd">func</span> <span class="n">loginWithGoogle</span><span class="o"><</span><span class="kt">T</span><span class="p">:</span> <span class="kt">UIViewController</span><span class="o">></span><span class="p">(</span><span class="nv">clientId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">viewController</span><span class="p">:</span> <span class="kt">T</span><span class="p">)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>viewController</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A view controller from which to launch the OAuth modal dialog</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>clientId</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The apps client id, provided by the service (Facebook, Google, etc.)</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:ZFC8SwiftDDP6Meteor6logoutFGSqFT6resultGSqPs9AnyObject__5errorGSqVS_8DDPError__T__T_"></a>
|
|
<a name="//apple_ref/swift/Method/logout(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor6logoutFGSqFT6resultGSqPs9AnyObject__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 of the server and executes a callback when the logout process has completed</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">static</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>An optional closure to be executed after the client has logged out</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:ZFC8SwiftDDP6Meteor6logoutFT_T_"></a>
|
|
<a name="//apple_ref/swift/Method/logout()" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor6logoutFT_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 of 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">static</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:CC8SwiftDDP6Meteor6Client"></a>
|
|
<a name="//apple_ref/swift/Class/Client" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:CC8SwiftDDP6Meteor6Client">Client</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Meteor.Client is a subclass of DDPClient that facilitates interaction with the MeteorCollection class</p>
|
|
|
|
<a href="../Classes/Meteor/Client.html" class="slightly-smaller">See more</a>
|
|
</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">class</span> <span class="kt">Client</span><span class="p">:</span> <span class="kt">DDPClient</span></code></pre>
|
|
|
|
</div>
|
|
</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>
|