502 lines
25 KiB
HTML
502 lines
25 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"> Docs</a> (61% documented)</p>
|
|
</div>
|
|
</header>
|
|
<div class="content-wrapper">
|
|
<p id="breadcrumbs">
|
|
<a href="../index.html"> Reference</a>
|
|
<img id="carat" src="../img/carat.png" />
|
|
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/DDPClient.html">DDPClient</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/Meteor.html">Meteor</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/MeteorCollection.html">MeteorCollection</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes.html#/s:C8SwiftDDP14MeteorCoreData">MeteorCoreData</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/MeteorCoreDataCollection.html">MeteorCoreDataCollection</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Classes/MeteorCoreDataTableViewController.html">MeteorCoreDataTableViewController</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-group-name">
|
|
<a href="../Enums.html">Enums</a>
|
|
<ul class="nav-group-tasks">
|
|
<li class="nav-group-task">
|
|
<a href="../Enums/DDPMessageType.html">DDPMessageType</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-group-name">
|
|
<a href="../Extensions.html">Extensions</a>
|
|
<ul class="nav-group-tasks">
|
|
<li class="nav-group-task">
|
|
<a href="../Extensions/DDPClient.html">DDPClient</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Extensions/NSManagedObject.html">NSManagedObject</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-group-name">
|
|
<a href="../Protocols.html">Protocols</a>
|
|
<ul class="nav-group-tasks">
|
|
<li class="nav-group-task">
|
|
<a href="../Protocols/MeteorCoreDataCollectionDelegate.html">MeteorCoreDataCollectionDelegate</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Protocols/MeteorCoreDataStack.html">MeteorCoreDataStack</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="nav-group-name">
|
|
<a href="../Structs.html">Structs</a>
|
|
<ul class="nav-group-tasks">
|
|
<li class="nav-group-task">
|
|
<a href="../Structs/DDPError.html">DDPError</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Structs/DDPEvents.html">DDPEvents</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Structs/DDPMessage.html">DDPMessage</a>
|
|
</li>
|
|
<li class="nav-group-task">
|
|
<a href="../Structs/Result.html">Result</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
<article class="main-content">
|
|
<section>
|
|
<section class="section">
|
|
<h1>Meteor</h1>
|
|
<div class="declaration">
|
|
<div class="Swift">
|
|
<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="Swift">
|
|
<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:ZFC8SwiftDDP6Meteor9subscribeFMS0_FSSSS"></a>
|
|
<a name="//apple_ref/swift/Method/subscribe(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor9subscribeFMS0_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">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:ZFC8SwiftDDP6Meteor9subscribeFMS0_FTSS6paramsGSaPSs9AnyObject___SS"></a>
|
|
<a name="//apple_ref/swift/Method/subscribe(_:params:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor9subscribeFMS0_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">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:ZFC8SwiftDDP6Meteor9subscribeFMS0_FTSS6paramsGSqGSaPSs9AnyObject___8callbackGSqFT_T___SS"></a>
|
|
<a name="//apple_ref/swift/Method/subscribe(_:params:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor9subscribeFMS0_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">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:ZFC8SwiftDDP6Meteor9subscribeFMS0_FTSS8callbackGSqFT_T___SS"></a>
|
|
<a name="//apple_ref/swift/Method/subscribe(_:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor9subscribeFMS0_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">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:ZFC8SwiftDDP6Meteor7connectFMS0_FTSS5emailSS8passwordSS_T_"></a>
|
|
<a name="//apple_ref/swift/Method/connect(_:email:password:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:ZFC8SwiftDDP6Meteor7connectFMS0_FTSS5emailSS8passwordSS_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="Swift">
|
|
<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 to connect to</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: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="Swift">
|
|
<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>© 2015 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2015-11-01)</p>
|
|
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.3.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
|
|
</section>
|
|
</article>
|
|
</div>
|
|
</body>
|
|
</div>
|
|
</html>
|