SwiftDDP/Classes.html

373 lines
15 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<title>Classes 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="Classes 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" />
Classes 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>Classes</h1>
<p>The following classes are available globally.</p>
</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:C8SwiftDDP9DDPClient"></a>
<a name="//apple_ref/swift/Class/DDPClient" class="dashAnchor"></a>
<a class="token" href="#/s:C8SwiftDDP9DDPClient">DDPClient</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>DDPClient is the base class for communicating with a server using the DDP protocol</p>
<a href="Classes/DDPClient.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">DDPClient</span><span class="p">:</span> <span class="kt">NSObject</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:C8SwiftDDP5EJSON"></a>
<a name="//apple_ref/swift/Class/EJSON" class="dashAnchor"></a>
<a class="token" href="#/s:C8SwiftDDP5EJSON">EJSON</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>
<a href="Classes/EJSON.html" class="slightly-smaller">See more</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:C8SwiftDDP16MeteorCollection"></a>
<a name="//apple_ref/swift/Class/MeteorCollection" class="dashAnchor"></a>
<a class="token" href="#/s:C8SwiftDDP16MeteorCollection">MeteorCollection</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>
<a href="Classes/MeteorCollection.html" class="slightly-smaller">See more</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:C8SwiftDDP18AbstractCollection"></a>
<a name="//apple_ref/swift/Class/AbstractCollection" class="dashAnchor"></a>
<a class="token" href="#/s:C8SwiftDDP18AbstractCollection">AbstractCollection</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>
<a href="Classes/AbstractCollection.html" class="slightly-smaller">See more</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:C8SwiftDDP19MeteorOAuthServices"></a>
<a name="//apple_ref/swift/Class/MeteorOAuthServices" class="dashAnchor"></a>
<a class="token" href="#/s:C8SwiftDDP19MeteorOAuthServices">MeteorOAuthServices</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>
<a href="Classes/MeteorOAuthServices.html" class="slightly-smaller">See more</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:C8SwiftDDP14MeteorDocument"></a>
<a name="//apple_ref/swift/Class/MeteorDocument" class="dashAnchor"></a>
<a class="token" href="#/s:C8SwiftDDP14MeteorDocument">MeteorDocument</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>
<a href="Classes/MeteorDocument.html" class="slightly-smaller">See more</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/TODO:%20Login%20first%20with%20stored%20token"></a>
<a name="//apple_ref/swift/Section/TODO: Login first with stored token" class="dashAnchor"></a>
<a href="#/TODO:%20Login%20first%20with%20stored%20token">
<h3 class="section-name">TODO: Login first with stored token</h3>
</a>
</div>
<ul>
<li class="item">
<div>
<code>
<a name="/s:C8SwiftDDP31MeteorOAuthDialogViewController"></a>
<a name="//apple_ref/swift/Class/MeteorOAuthDialogViewController" class="dashAnchor"></a>
<a class="token" href="#/s:C8SwiftDDP31MeteorOAuthDialogViewController">MeteorOAuthDialogViewController</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>
<a href="Classes/MeteorOAuthDialogViewController.html" class="slightly-smaller">See more</a>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:C8SwiftDDP11MeteorOAuth"></a>
<a name="//apple_ref/swift/Class/MeteorOAuth" class="dashAnchor"></a>
<a class="token" href="#/s:C8SwiftDDP11MeteorOAuth">MeteorOAuth</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>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:C8SwiftDDP6Meteor"></a>
<a name="//apple_ref/swift/Class/Meteor" class="dashAnchor"></a>
<a class="token" href="#/s:C8SwiftDDP6Meteor">Meteor</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Meteor is a class to simplify communicating with and consuming MeteorJS server services</p>
<a href="Classes/Meteor.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">Meteor</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 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>