294 lines
12 KiB
HTML
294 lines
12 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<title>Structs 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 title="Structs 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" />
|
|
Structs 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>Structs</h1>
|
|
<p>The following structs are available globally.</p>
|
|
|
|
</section>
|
|
<section class="section task-group-section">
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:V8SwiftDDP10Completion"></a>
|
|
<a name="//apple_ref/swift/Struct/Completion" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:V8SwiftDDP10Completion">Completion</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Completion is a wrapper for DDP callbacks that ensures that callbacks are executed
|
|
on the same queue on which the original method was called. If the current queue is
|
|
not available, execution defaults to the main queue.</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">struct</span> <span class="kt">Completion</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:V8SwiftDDP6Result"></a>
|
|
<a name="//apple_ref/swift/Struct/Result" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:V8SwiftDDP6Result">Result</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>Struct to encapsulate the result of a Meteor method call</p>
|
|
|
|
<a href="Structs/Result.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">struct</span> <span class="kt">Result</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:V8SwiftDDP10DDPMessage"></a>
|
|
<a name="//apple_ref/swift/Struct/DDPMessage" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:V8SwiftDDP10DDPMessage">DDPMessage</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>A struct to parse, encapsulate and facilitate handling of DDP message strings</p>
|
|
|
|
<a href="Structs/DDPMessage.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">struct</span> <span class="kt">DDPMessage</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:V8SwiftDDP8DDPError"></a>
|
|
<a name="//apple_ref/swift/Struct/DDPError" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:V8SwiftDDP8DDPError">DDPError</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>A struct encapsulating a DDP error message</p>
|
|
|
|
<a href="Structs/DDPError.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">struct</span> <span class="kt">DDPError</span><span class="p">:</span> <span class="kt">ErrorType</span></code></pre>
|
|
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div class="task-group">
|
|
<ul>
|
|
<li class="item">
|
|
<div>
|
|
<code>
|
|
<a name="/s:V8SwiftDDP9DDPEvents"></a>
|
|
<a name="//apple_ref/swift/Struct/DDPEvents" class="dashAnchor"></a>
|
|
<a class="token" href="#/s:V8SwiftDDP9DDPEvents">DDPEvents</a>
|
|
</code>
|
|
</div>
|
|
<div class="height-container">
|
|
<div class="pointer-container"></div>
|
|
<section class="section">
|
|
<div class="pointer"></div>
|
|
<div class="abstract">
|
|
<p>DDPEvents is a struct holder for callback closures that execute in response to
|
|
websocket and Meteor lifecyle events. New closures can be assigned to public
|
|
closures to modify the clients behavior in response to the trigger event.</p>
|
|
|
|
<a href="Structs/DDPEvents.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">struct</span> <span class="kt">DDPEvents</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>
|