1044 lines
49 KiB
HTML
1044 lines
49 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>DDPClient 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/DDPClient" class="dashAnchor"></a>
|
|
<a title="DDPClient 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" />
|
|
DDPClient 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>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>
|
|
<p>DDPClient is the base class for communicating with a server using the DDP protocol</p>
|
|
|
|
</section>
|
|
<section class="section task-group-section">
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:vC8SwiftDDP9DDPClient8logLevelOC9XCGLogger9XCGLogger8LogLevel"></a>
|
|
<a name="//apple_ref/swift/Property/logLevel" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:vC8SwiftDDP9DDPClient8logLevelOC9XCGLogger9XCGLogger8LogLevel">logLevel</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:FC8SwiftDDP9DDPClient5getIdFS0_FT_SS"></a>
|
|
<a name="//apple_ref/swift/Method/getId()" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient5getIdFS0_FT_SS">getId()</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 random String id</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">getId</span><span class="p">()</span> <span class="o">-></span> <span class="kt">String</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient7connectFS0_FTSS8callbackGSqFT7sessionSS_T___T_"></a>
|
|
<a name="//apple_ref/swift/Method/connect(_:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient7connectFS0_FTSS8callbackGSqFT7sessionSS_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>Makes a DDP connection 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">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="nv">session</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span><span class="o">-></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 String url to connect to, ex. <q>wss://todos.meteor.com/websocket</q></p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>callback</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A closure that takes a String argument with the value of the websocket session token</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient11setLogLevelFS0_FOC9XCGLogger9XCGLogger8LogLevelT_"></a>
|
|
<a name="//apple_ref/swift/Method/setLogLevel(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient11setLogLevelFS0_FOC9XCGLogger9XCGLogger8LogLevelT_">setLogLevel(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Sets the XCGLogger loglevel.</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">setLogLevel</span><span class="p">(</span><span class="nv">logLevel</span><span class="p">:</span><span class="kt">XCGLogger</span><span class="o">.</span><span class="kt">LogLevel</span><span class="p">)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>logLevel</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>An XCGLogger LogLevel enum value, ex. .Info, .Debug, .Error</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient6methodFS0_FTSS6paramsGSqPSs9AnyObject__8callbackGSqFT6resultGSqPS1___5errorGSqVS_8DDPError__T___SS"></a>
|
|
<a name="//apple_ref/swift/Method/method(_:params:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient6methodFS0_FTSS6paramsGSqPSs9AnyObject__8callbackGSqFT6resultGSqPS1___5errorGSqVS_8DDPError__T___SS">method(_: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>Executes 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="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">method</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></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 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 method has been executed</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient3subFS0_FTSS6paramsGSqGSaPSs9AnyObject____SS"></a>
|
|
<a name="//apple_ref/swift/Method/sub(_:params:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient3subFS0_FTSS6paramsGSqGSaPSs9AnyObject____SS">sub(_: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">sub</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="p">[</span><span class="kt">AnyObject</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>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:FC8SwiftDDP9DDPClient3subFS0_FTSS6paramsGSqGSaPSs9AnyObject___8callbackGSqFT_T___SS"></a>
|
|
<a name="//apple_ref/swift/Method/sub(_:params:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient3subFS0_FTSS6paramsGSqGSaPSs9AnyObject___8callbackGSqFT_T___SS">sub(_: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">sub</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="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></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:FC8SwiftDDP9DDPClient5unsubFS0_FSSGSqSS_"></a>
|
|
<a name="//apple_ref/swift/Method/unsub(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient5unsubFS0_FSSGSqSS_">unsub(_:)</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.</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">unsub</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></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:FC8SwiftDDP9DDPClient5unsubFS0_FTSS8callbackGSqFT_T___GSqSS_"></a>
|
|
<a name="//apple_ref/swift/Method/unsub(_:callback:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient5unsubFS0_FTSS8callbackGSqFT_T___GSqSS_">unsub(_: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. If a callback is passed, the callback asynchronously
|
|
runs when the client receives a ‘ready’ message indicating that the subset of documents contained
|
|
in the subscription have been removed.</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">unsub</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></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:FC8SwiftDDP9DDPClient19subscriptionIsReadyFS0_FTSS16subscriptionNameSS_T_"></a>
|
|
<a name="//apple_ref/swift/Method/subscriptionIsReady(_:subscriptionName:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient19subscriptionIsReadyFS0_FTSS16subscriptionNameSS_T_">subscriptionIsReady(_:subscriptionName:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Executes when a subscription is ready.</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">subscriptionIsReady</span><span class="p">(</span><span class="nv">subscriptionId</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">subscriptionName</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span> <span class="p">{}</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>subscriptionId</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A String representation of the hash of the subscription name</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>subscriptionName</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:FC8SwiftDDP9DDPClient22subscriptionWasRemovedFS0_FTSS16subscriptionNameSS_T_"></a>
|
|
<a name="//apple_ref/swift/Method/subscriptionWasRemoved(_:subscriptionName:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient22subscriptionWasRemovedFS0_FTSS16subscriptionNameSS_T_">subscriptionWasRemoved(_:subscriptionName:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Executes when a subscription is removed.</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">subscriptionWasRemoved</span><span class="p">(</span><span class="nv">subscriptionId</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">subscriptionName</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span> <span class="p">{}</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>subscriptionId</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A String representation of the hash of the subscription name</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>subscriptionName</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:FC8SwiftDDP9DDPClient16documentWasAddedFS0_FTSS2idSS6fieldsGSqCSo12NSDictionary__T_"></a>
|
|
<a name="//apple_ref/swift/Method/documentWasAdded(_:id:fields:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient16documentWasAddedFS0_FTSS2idSS6fieldsGSqCSo12NSDictionary__T_">documentWasAdded(_:id:fields:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Executes when the server has sent a new document.</p>
|
|
|
|
</div>
|
|
<div class="declaration">
|
|
<h4>Declaration</h4>
|
|
<div class="Swift">
|
|
<p class="aside-title">Swift</p>
|
|
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">func</span> <span class="nf">documentWasAdded</span><span class="p">(</span><span class="nv">collection</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">id</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">fields</span><span class="p">:</span><span class="kt">NSDictionary</span><span class="p">?)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>collection</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The name of the collection that the document belongs to</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>id</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The document’s unique id</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>fields</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The documents properties</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient18documentWasRemovedFS0_FTSS2idSS_T_"></a>
|
|
<a name="//apple_ref/swift/Method/documentWasRemoved(_:id:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient18documentWasRemovedFS0_FTSS2idSS_T_">documentWasRemoved(_:id:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Executes when the server sends a message to remove a document.</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">documentWasRemoved</span><span class="p">(</span><span class="nv">collection</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">id</span><span class="p">:</span><span class="kt">String</span><span class="p">)</span></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 that the document belongs to</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>id</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The document’s unique id</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient18documentWasChangedFS0_FTSS2idSS6fieldsGSqCSo12NSDictionary_7clearedGSqGSaSS___T_"></a>
|
|
<a name="//apple_ref/swift/Method/documentWasChanged(_:id:fields:cleared:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient18documentWasChangedFS0_FTSS2idSS6fieldsGSqCSo12NSDictionary_7clearedGSqGSaSS___T_">documentWasChanged(_:id:fields:cleared:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Executes when the server sends a message to update a document.</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">documentWasChanged</span><span class="p">(</span><span class="nv">collection</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">id</span><span class="p">:</span><span class="kt">String</span><span class="p">,</span> <span class="nv">fields</span><span class="p">:</span><span class="kt">NSDictionary</span><span class="p">?,</span> <span class="nv">cleared</span><span class="p">:[</span><span class="kt">String</span><span class="p">]?)</span></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 that the document belongs to</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>id</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>The document’s unique id</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>fields</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>Optional object with EJSON values containing the fields to update</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>cleared</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>Optional array of strings (field names to delete)</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient16methodWasUpdatedFS0_FGSaSS_T_"></a>
|
|
<a name="//apple_ref/swift/Method/methodWasUpdated(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient16methodWasUpdatedFS0_FGSaSS_T_">methodWasUpdated(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Executes when the server sends a message indicating that the result of a method has changed.</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">methodWasUpdated</span><span class="p">(</span><span class="nv">methods</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>methods</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>An array of strings (ids passed to ‘method’, all of whose writes have been reflected in data messages)</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:FC8SwiftDDP9DDPClient22didReceiveErrorMessageFS0_FVS_8DDPErrorT_"></a>
|
|
<a name="//apple_ref/swift/Method/didReceiveErrorMessage(_:)" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:FC8SwiftDDP9DDPClient22didReceiveErrorMessageFS0_FVS_8DDPErrorT_">didReceiveErrorMessage(_:)</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Executes when the client receives an error message from the server. Such a message is used to represent errors raised by the method or subscription, as well as an attempt to subscribe to an unknown subscription or call an unknown method.</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">didReceiveErrorMessage</span><span class="p">(</span><span class="nv">message</span><span class="p">:</span> <span class="kt">DDPError</span><span class="p">)</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<h4>Parameters</h4>
|
|
<table class="graybox">
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>
|
|
<em>message</em>
|
|
</code>
|
|
</td>
|
|
<td>
|
|
<div>
|
|
<p>A DDPError object with information about the error</p>
|
|
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</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>
|